org.xwalk.core

Class XWalkExtension

java.lang.Object

org.xwalk.core.XWalkExtension

public abstract class XWalkExtension
extends java.lang.Object

This class represents an extension and could be implemented by callers.

Constructor Summary

Constructors

Constructor and Description
XWalkExtension(java.lang.String name, java.lang.String jsApi) Constructor with name and javascript API.
XWalkExtension(java.lang.String name, java.lang.String jsApi, java.lang.String[] entryPoints) Constructor with name, javascript API and entry points.

Method Summary

Modifier and Type	Method and Description
void	broadcastMessage(java.lang.String message) Broadcast message to all extension instances.
protected java.lang.Object	getBridge()
void	onBinaryMessage(int instanceID, byte[] message) Notify the extension that the async binary message is received.
void	onInstanceCreated(int instanceID) Notify the extension that an instance is created.
void	onInstanceDestroyed(int instanceID) Notify the extension that an instance is destroyed.
abstract void	onMessage(int instanceID, java.lang.String message) Notify the extension that the async message is received.
abstract java.lang.String	onSyncMessage(int instanceID, java.lang.String message) Notify the extension that the sync message is received.
void	postBinaryMessage(int instanceID, byte[] message) Send binary message to an instance.
void	postMessage(int instanceID, java.lang.String message) Send message to an instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

XWalkExtension

public XWalkExtension(java.lang.String name,
                      java.lang.String jsApi)

Constructor with name and javascript API.

Parameters:

name - the exposed namespace.

jsApi - the string of javascript API.

Since:

2.1

XWalkExtension

public XWalkExtension(java.lang.String name,
                      java.lang.String jsApi,
                      java.lang.String[] entryPoints)

Constructor with name, javascript API and entry points.

Parameters:

name - the exposed namespace.

jsApi - the string of javascript API.

entryPoints - Entry points are used when the extension needs to have objects outside the namespace that is implicitly created using its name.

Since:

2.1

Method Detail

getBridge

protected java.lang.Object getBridge()

postMessage

public void postMessage(int instanceID,
                        java.lang.String message)

Send message to an instance.

Parameters:

instanceID - the id of instance.

message - the message.

Since:

2.1

postBinaryMessage

public void postBinaryMessage(int instanceID,
                              byte[] message)

Send binary message to an instance.

Parameters:

instanceID - the id of instance.

message - the binary message.

Since:

6.0

broadcastMessage

public void broadcastMessage(java.lang.String message)

Broadcast message to all extension instances.

Parameters:

message - the message.

Since:

2.1

onInstanceCreated

public void onInstanceCreated(int instanceID)

Notify the extension that an instance is created.

Parameters:

instanceID - the id of instance.

Since:

15.45

onInstanceDestroyed

public void onInstanceDestroyed(int instanceID)

Notify the extension that an instance is destroyed.

Parameters:

instanceID - the id of instance.

Since:

15.45

onBinaryMessage

public void onBinaryMessage(int instanceID,
                            byte[] message)

Notify the extension that the async binary message is received.

Parameters:

instanceID - the id of instance.

message - the received binar message.

Since:

6.0

onMessage

public abstract void onMessage(int instanceID,
                               java.lang.String message)

Notify the extension that the async message is received.

Parameters:

instanceID - the id of instance.

message - the received message.

Since:

2.1

onSyncMessage

public abstract java.lang.String onSyncMessage(int instanceID,
                                               java.lang.String message)

Notify the extension that the sync message is received.

Parameters:

instanceID - the id of instance.

message - the received message.

Since:

2.1