externally_connectable doc improvements #20438
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
|
Preview URLs
External URLs (1)URL:
(this comment was updated 2022-09-25 22:04:34.565202) |
Rob--W
requested changes
Sep 8, 2022
| @@ -24,6 +24,8 @@ You can call this: | |||
|
|
|||
| Note that you can't use this function to connect an extension to its content scripts. To do this, use {{WebExtAPIRef('tabs.connect()')}}. | |||
|
|
|||
| By default, this connection can exchange messages with any other extension. However, the [`externally_connectable`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/externally_connectable) manifest key can be used to limit communication to specific extensions and enable communication with websites. | |||
There was a problem hiding this comment.
Suggested change
| By default, this connection can exchange messages with any other extension. However, the [`externally_connectable`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/externally_connectable) manifest key can be used to limit communication to specific extensions and enable communication with websites. | |
| By default, this connection can exchange messages with any other extension instead of itself via the `extensionId` parameter. However, the [`externally_connectable`](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/externally_connectable) manifest key can be used to limit communication to specific extensions and enable communication with websites. |
Clarification; please apply something along the lines of this to all similar texts in the PR.
| @@ -15,14 +15,16 @@ browser-compat: webextensions.api.runtime.onMessageExternal | |||
| --- | |||
| {{AddonSidebar()}} | |||
|
|
|||
| Use this event to listen for messages from another extension. | |||
There was a problem hiding this comment.
Keep this; "from another extension or web page".
Explicitly not the extension itself.
|
|
||
| > **Note:** | ||
| > For communication with web pages: | ||
| > - In Chrome, `chrome.runtime.connect` and `chrome.runtime.sendMessage` are used. |
There was a problem hiding this comment.
Add sentence:
These methods are only available if there is at least one extension that listens for messages (https://groups.google.com/a/chromium.org/g/chromium-extensions/c/tCWVZRq77cg/m/KB6-tvCdAgAJ).
(Maybe something link text instead of just a plain link?)
Rob--W
reviewed
Sep 13, 2022
files/en-us/mozilla/add-ons/webextensions/api/runtime/connect/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Rob Wu <[email protected]>
Rob--W
approved these changes
Sep 25, 2022
himanshugarg
pushed a commit
to himanshugarg/content
that referenced
this pull request
Sep 27, 2022
* externally_connectable doc improvements * Updates from feedback * lint issues fix * Review feedback Co-authored-by: Rob Wu <[email protected]> Co-authored-by: Rob Wu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change removes the experimental flag from the
externally_connectablemanifest key and adds clarification about the APIs that can be used to send messages from webpages to extensions. Also, references to the function ofexternally_connectableare added toruntime.sendMessage(),runtime.onMessageExternal, andruntime.connect().Motivation
Complete work started in #19838