Package org.mozilla.geckoview

Class WebExtension.Port

Object

org.mozilla.geckoview.WebExtension.Port

Enclosing class:

WebExtension

@UiThread
public static class WebExtension.Port
extends Object

Port object that can be used for bidirectional communication with a WebExtension.

See also: WebExtensions/API/runtime/Port .

See Also:

• WebExtension.MessageDelegate.onConnect(org.mozilla.geckoview.WebExtension.Port)

Field Summary

Fields

Modifier and Type	Field	Description
final String	name	The application identifier of the MessageDelegate that opened this port.
final WebExtension.MessageSender	sender	WebExtension.MessageSender corresponding to this port.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Port()	Override for tests.

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Disconnects this port and notifies the other end.
void	postMessage(JSONObject message)	Post a message to the WebExtension connected to this WebExtension.Port instance.
void	setDelegate(WebExtension.PortDelegate delegate)	Set a delegate for incoming messages through this WebExtension.Port.

Methods inherited from class java.lang.Object

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

Field Details

sender

@NonNull
public final WebExtension.MessageSender sender

WebExtension.MessageSender corresponding to this port.

name

@NonNull
public final String name

The application identifier of the MessageDelegate that opened this port.

Constructor Details

Port

protected Port()

Override for tests.

Method Details

postMessage

public void postMessage(@NonNull
 JSONObject message)

Post a message to the WebExtension connected to this WebExtension.Port instance.

Parameters:

message - JSONObject that will be sent to the WebExtension.

disconnect

public void disconnect()

Disconnects this port and notifies the other end.

setDelegate

public void setDelegate(@Nullable
 WebExtension.PortDelegate delegate)

Set a delegate for incoming messages through this WebExtension.Port.

Parameters:

delegate - Delegate that will receive messages sent through this WebExtension.Port.