Package org.mozilla.geckoview

Class WebExtension.MessageSender

Object

org.mozilla.geckoview.WebExtension.MessageSender

Enclosing class:

WebExtension

@UiThread
public static class WebExtension.MessageSender
extends Object

Describes the sender of a message from a WebExtension.

See also: WebExtensions/API/runtime/MessageSender

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	WebExtension.MessageSender.EnvType	Environment type definitions for WebExtension messaging.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ENV_TYPE_CONTENT_SCRIPT	This sender originated inside a content script.
static final int	ENV_TYPE_EXTENSION	This sender originated inside a privileged extension context like a background script.
final int	environmentType	Type of environment that sent this message, either ENV_TYPE_EXTENSION if the message was sent from a background page ENV_TYPE_CONTENT_SCRIPT if the message was sent from a content script
final GeckoSession	session	GeckoSession that sent this message.
final String	url	URL of the frame that sent this message.
final WebExtension	webExtension	WebExtension that sent this message.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageSender()	Override for testing.

Method Summary

Modifier and Type	Method	Description
boolean	isTopLevel()	Whether this MessageSender belongs to a top level frame.

Methods inherited from class java.lang.Object

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

Field Details

webExtension

@NonNull
public final WebExtension webExtension

WebExtension that sent this message.

session

@Nullable
public final GeckoSession session

GeckoSession that sent this message. null if coming from a background script.

ENV_TYPE_EXTENSION

public static final int ENV_TYPE_EXTENSION

This sender originated inside a privileged extension context like a background script.

See Also:

• Constant Field Values

ENV_TYPE_CONTENT_SCRIPT

public static final int ENV_TYPE_CONTENT_SCRIPT

This sender originated inside a content script.

See Also:

• Constant Field Values

environmentType

public final int environmentType

Type of environment that sent this message, either

• ENV_TYPE_EXTENSION if the message was sent from a background page
• ENV_TYPE_CONTENT_SCRIPT if the message was sent from a content script

url

@NonNull
public final String url

URL of the frame that sent this message.

Use this value together with isTopLevel to verify that the message is coming from the expected page. Only top level frames can be trusted.

Constructor Details

MessageSender

protected MessageSender()

Override for testing.

Method Details

isTopLevel

public boolean isTopLevel()

Whether this MessageSender belongs to a top level frame.

Returns:

true if the MessageSender was sent from the top level frame, false otherwise.