Package org.mozilla.geckoview

Class WebExtension

Object

org.mozilla.geckoview.WebExtension

public class WebExtension
extends Object

Represents a WebExtension that may be used by GeckoView.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebExtension.Action	Represents either a Browser Action or a Page Action from the WebExtension API.
static interface	WebExtension.ActionDelegate	Receives updates whenever a Browser action or a Page action has been defined by an extension.
static @interface	WebExtension.BlocklistState	Blocklist state definitions for extensions.
static class	WebExtension.BlocklistStateFlags	Describes the blocklist state for a WebExtension.
static interface	WebExtension.BrowsingDataDelegate	This delegate is used to handle calls from the |browsingData| WebExtension API.
static @interface	WebExtension.BrowsingDataTypes	Browsing data type definitions for extensions.
static @interface	WebExtension.ContextFlags	Context flag definitions for menu items.
static class	WebExtension.CreateTabDetails	Provides details about creating a tab with tabs.create.
static class	WebExtension.DisabledFlags	Flags indicating reasons why an extension is disabled.
static class	WebExtension.Download	Represents a download for downloads API Instantiate using WebExtensionController.createDownload(int)
static interface	WebExtension.DownloadDelegate	Handles download requests from WebExtensions.
static class	WebExtension.DownloadInitData	Represents initial information on a download provided to Web Extension
static class	WebExtension.DownloadRequest	Represents Web Extension API specific download request
static @interface	WebExtension.EnabledFlags	Enabled/disabled flag definitions for WebExtensions.
static class	WebExtension.Flags	Flags that can be used to configure WebExtension behavior.
static class	WebExtension.InstallException	Extension thrown when an error occurs during extension installation.
static class	WebExtension.InvalidMetaDataException	Exception thrown when GeckoView receives unexpected invalid WebExtension metadata from Gecko (e.g.
static interface	WebExtension.MessageDelegate	Delegates that responds to messages sent from a WebExtension.
static class	WebExtension.MessageSender	Describes the sender of a message from a WebExtension.
class	WebExtension.MetaData	Provides information about a WebExtension.
static class	WebExtension.PermissionPromptResponse	Holds all the information which the user has submited as part of a confirmation of a permissions prompt request.
static class	WebExtension.Port	Port object that can be used for bidirectional communication with a WebExtension.
static interface	WebExtension.PortDelegate	Delegate that handles communication from a WebExtension on a specific WebExtension.Port instance.
static class	WebExtension.SessionController	Controller for WebExtension session-related APIs (tabs, browsingData, downloads, etc.).
static interface	WebExtension.SessionTabDelegate	This delegate is invoked whenever an extension uses the `tabs` WebExtension API to modify the state of a tab.
static @interface	WebExtension.SignedState	Signed state type definitions for WebExtension verification status.
static class	WebExtension.SignedStateFlags	Describes the signed status for a WebExtension.
static interface	WebExtension.TabDelegate	This delegate is invoked whenever an extension uses the `tabs` WebExtension API and the request is not specific to an existing tab, e.g.
static class	WebExtension.UpdateTabDetails	Provides details about upating a tab with tabs.update.
static @interface	WebExtension.WebExtensionFlags	Defines the valid flags that can be applied to a WebExtension.

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	DATA_COLLECTION_PERMISSIONS	The list of data collection permission names.
final long	flags	WebExtension.Flags for this WebExtension.
final String	id	Unique identifier for this WebExtension
final boolean	isBuiltIn	Whether this extension is built-in.
final String	location	file: or resource: URI that points to the install location of this WebExtension.
final WebExtension.MetaData	metaData	Provides information about this WebExtension.

Method Summary

Modifier and Type	Method	Description
WebExtension.BrowsingDataDelegate	getBrowsingDataDelegate()	Returns the delegate handling browsing-data operations for this extension.
WebExtension.DownloadDelegate	getDownloadDelegate()	Get the download delegate for this extension.
WebExtension.TabDelegate	getTabDelegate()	Get the tab delegate for this extension.
void	setActionDelegate(WebExtension.ActionDelegate delegate)	Set the Action delegate for this WebExtension.
void	setBrowsingDataDelegate(WebExtension.BrowsingDataDelegate delegate)	Sets the delegate to handle browsing-data operations (clear, remove, get settings).
void	setDownloadDelegate(WebExtension.DownloadDelegate delegate)	Set the download delegate for this extension.
void	setMessageDelegate(WebExtension.MessageDelegate messageDelegate, String nativeApp)	Defines the message delegate for a Native App.
void	setTabDelegate(WebExtension.TabDelegate delegate)	Set the tab delegate for this extension.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

location

@NonNull
public final String location

file: or resource: URI that points to the install location of this WebExtension. When the WebExtension is included with the APK the file can be specified using the resource://android alias. E.g.

      resource://android/assets/web_extensions/my_webextension/
 

Will point to folder /assets/web_extensions/my_webextension/ in the APK.

id

@NonNull
public final String id

Unique identifier for this WebExtension

flags

public final long flags

WebExtension.Flags for this WebExtension.

metaData

@NonNull
public final WebExtension.MetaData metaData

Provides information about this WebExtension.

isBuiltIn

public final boolean isBuiltIn

Whether this extension is built-in. Built-in extension can be installed using WebExtensionController.installBuiltIn(java.lang.String).

DATA_COLLECTION_PERMISSIONS

public static final List<String> DATA_COLLECTION_PERMISSIONS

The list of data collection permission names.

This list should be kept in sync with the WebExtensions JSON schema defined at the gecko toolkit level. It is made public so that upper Android layers can have access to a list of data collection permissions that is guaranteed to match the gecko one, which can be useful in tests for instance.

Method Details

toString

public String toString()

Overrides:

toString in class Object

setMessageDelegate

@UiThread
public void setMessageDelegate(@Nullable
 WebExtension.MessageDelegate messageDelegate,
 @NonNull
 String nativeApp)

Defines the message delegate for a Native App.

This message delegate will receive messages from the background script for the native app specified in nativeApp.

For messages from content scripts, set a session-specific message delegate using WebExtension.SessionController.setMessageDelegate(org.mozilla.geckoview.WebExtension, org.mozilla.geckoview.WebExtension.MessageDelegate, java.lang.String).

See also WebExtensions/Native_messaging

Parameters:

messageDelegate - handles messaging between the WebExtension and the app. To send a message from the WebExtension use the runtime.sendNativeMessage WebExtension API: E.g.

        browser.runtime.sendNativeMessage(nativeApp,
              {message: "Hello from WebExtension!"});
      

For bidirectional communication, use runtime.connectNative. E.g. in a content script:

          let port = browser.runtime.connectNative(nativeApp);
          port.onMessage.addListener(message => {
              console.log("Message received from app");
          });
          port.postMessage("Ping from WebExtension");
      

The code above will trigger a WebExtension.MessageDelegate.onConnect(org.mozilla.geckoview.WebExtension.Port) call that will contain the corresponding WebExtension.Port object that can be used to send messages to the WebExtension. Note: the nativeApp specified in the WebExtension needs to match the nativeApp parameter of this method.

You can unset the message delegate by setting a null messageDelegate.

nativeApp - which native app id this message delegate will handle messaging for. Needs to match the application parameter of runtime.sendNativeMessage and runtime.connectNative.

See Also:

• WebExtension.SessionController.setMessageDelegate(org.mozilla.geckoview.WebExtension, org.mozilla.geckoview.WebExtension.MessageDelegate, java.lang.String)

getTabDelegate

@UiThread
@Nullable
public WebExtension.TabDelegate getTabDelegate()

Get the tab delegate for this extension.

See also WebExtensions/API/tabs.

Returns:

The WebExtension.TabDelegate instance for this extension.

setTabDelegate

@UiThread
public void setTabDelegate(@Nullable
 WebExtension.TabDelegate delegate)

Set the tab delegate for this extension. This delegate will be invoked whenever this extension tries to modify the tabs state using the `tabs` WebExtension API.

See also WebExtensions/API/tabs.

Parameters:

delegate - the WebExtension.TabDelegate instance for this extension.

getBrowsingDataDelegate

@UiThread
@Nullable
public WebExtension.BrowsingDataDelegate getBrowsingDataDelegate()

Returns the delegate handling browsing-data operations for this extension.

Returns:

the current BrowsingDataDelegate, or null if none set

setBrowsingDataDelegate

@UiThread
public void setBrowsingDataDelegate(@Nullable
 WebExtension.BrowsingDataDelegate delegate)

Sets the delegate to handle browsing-data operations (clear, remove, get settings).

Parameters:

delegate - the BrowsingDataDelegate to receive browsing-data calls; may be null

setActionDelegate

@AnyThread
public void setActionDelegate(@Nullable
 WebExtension.ActionDelegate delegate)

Set the Action delegate for this WebExtension.

This delegate will receive updates every time the default Action value changes.

To listen for GeckoSession-specific updates, use WebExtension.SessionController.setActionDelegate(org.mozilla.geckoview.WebExtension, org.mozilla.geckoview.WebExtension.ActionDelegate)

Parameters:

delegate - WebExtension.ActionDelegate that will receive updates.

setDownloadDelegate

@UiThread
public void setDownloadDelegate(@Nullable
 WebExtension.DownloadDelegate delegate)

Set the download delegate for this extension. This delegate will be invoked whenever this extension tries to use the `downloads` WebExtension API.

See also WebExtensions/API/downloads.

Parameters:

delegate - the WebExtension.DownloadDelegate instance for this extension.

getDownloadDelegate

@UiThread
@Nullable
public WebExtension.DownloadDelegate getDownloadDelegate()

Get the download delegate for this extension.

See also WebExtensions downloads API.

Returns:

The WebExtension.DownloadDelegate instance for this extension.