Package org.mozilla.geckoview

Class WebExtension.MetaData

Object

org.mozilla.geckoview.WebExtension.MetaData

Enclosing class:

WebExtension

public class WebExtension.MetaData
extends Object

Provides information about a WebExtension.

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	allowedInPrivateBrowsing	Whether this extension is allowed to run in private browsing or not.
final String	baseUrl	Root URL for this extension's pages.
final int	blocklistState	Blocklist status for this extension.
final String	creatorName	Creator name as provided in the manifest.
final String	creatorUrl	Creator url as provided in the manifest.
final String	description	Branding description for this extension.
final int	disabledFlags	Disabled binary flags for this extension.
final boolean	enabled	Whether this extension is enabled or not.
final String	homepageUrl	Homepage url as provided in the manifest.
final Image	icon	Main Image branding for this WebExtension.
final boolean	isRecommended	Whether or not this is a recommended extension.
final String	name	Branding name for this extension.
final boolean	openOptionsPageInTab	Whether the options page should be open in a Tab or not.
final String	optionsPageUrl	Options page as provided in the manifest.
final String[]	origins	Host permissions requested or granted to this extension.
final String[]	permissions	API permissions requested or granted to this extension.
final int	signedState	Signed status for this extension.
final boolean	temporary	Whether this extension is temporary or not.
final String	version	Version string for this extension.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetaData()	Override for testing.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

icon

@NonNull
public final Image icon

Main Image branding for this WebExtension. Can be used when displaying prompts.

permissions

@NonNull
public final String[] permissions

API permissions requested or granted to this extension.

Permission identifiers match entries in the manifest, see API permissions .

origins

@NonNull
public final String[] origins

Host permissions requested or granted to this extension.

See Host permissions .

name

@Nullable
public final String name

Branding name for this extension.

See manifest.json/name

description

@Nullable
public final String description

Branding description for this extension. This string will be localized using the current GeckoView language setting.

See manifest.json/description

version

@NonNull
public final String version

Version string for this extension.

See manifest.json/version

creatorName

@Nullable
public final String creatorName

Creator name as provided in the manifest.

See manifest.json/developer

creatorUrl

@Nullable
public final String creatorUrl

Creator url as provided in the manifest.

See manifest.json/developer

homepageUrl

@Nullable
public final String homepageUrl

Homepage url as provided in the manifest.

See manifest.json/homepage_url

optionsPageUrl

@Nullable
public final String optionsPageUrl

Options page as provided in the manifest.

See manifest.json/options_ui

openOptionsPageInTab

public final boolean openOptionsPageInTab

Whether the options page should be open in a Tab or not.

See manifest.json/options_ui#Syntax

isRecommended

public final boolean isRecommended

Whether or not this is a recommended extension.

See Recommended Extensions program

blocklistState

public final int blocklistState

Blocklist status for this extension.

See Add-ons that cause stability or security issues are put on a blocklist .

signedState

public final int signedState

Signed status for this extension.

See Add-on signing in Firefox. .

disabledFlags

public final int disabledFlags

Disabled binary flags for this extension.

This will be either equal to 0 if the extension is enabled or will contain one or more flags from WebExtension.DisabledFlags.

e.g. if the extension has been disabled by the user, the value in WebExtension.DisabledFlags.USER will be equal to 1:

     boolean isUserDisabled = metaData.disabledFlags
          & DisabledFlags.USER > 0;
 

baseUrl

@NonNull
public final String baseUrl

Root URL for this extension's pages. Can be used to determine if a given URL belongs to this extension.

allowedInPrivateBrowsing

public final boolean allowedInPrivateBrowsing

Whether this extension is allowed to run in private browsing or not. To modify this value use WebExtensionController.setAllowedInPrivateBrowsing(org.mozilla.geckoview.WebExtension, boolean).

enabled

public final boolean enabled

Whether this extension is enabled or not.

temporary

public final boolean temporary

Whether this extension is temporary or not. Temporary extensions are not retained and will be uninstalled when the browser exits.

Constructor Details

MetaData

protected MetaData()

Override for testing.