com.openfin.desktop.channel

Class Channel

java.lang.Object

com.openfin.desktop.channel.Channel

public class Channel
extends Object

The Channel object allows an OpenFin application to create a channel as a ChannelProvider, or connect to a channel as a ChannelClient.

Author:

Anthony

Constructor Summary

Constructors

Constructor and Description
Channel(String name, DesktopConnection desktopConnection)

Method Summary

Modifier and Type	Method and Description
boolean	addChannelListener(ChannelListener listener)
protected void	addEventListener(org.json.JSONObject subscriptionObject, EventListener listener, AckListener callback) Registers an event listener on the specified event
void	addEventListener(String type, EventListener listener, AckListener callback) Registers an event listener on the specified event
void	connect(AsyncCallback<ChannelClient> callback) Connect to the channel.
CompletionStage<ChannelClient>	connectAsync() Connect to a channel provider
CompletionStage<ChannelClient>	connectAsync(Boolean noWait, Object connectPayload) Connect to a channel provider with a payload passed to the provider
CompletionStage<ChannelClient>	connectAsync(Object connectPayload) Connect to a channel provider with a payload passed to the provider
void	create(AsyncCallback<ChannelProvider> callback) Create a new channel.
CompletionStage<ChannelProvider>	createAsync()
protected void	fireChannelConnectEvent(ConnectionEvent event)
protected void	fireChannelDisconnectEvent(ConnectionEvent event)
DesktopConnection	getDesktopConnection()
String	getName() Get the name of the channel
boolean	hasClient() Check if the channel has client connected
boolean	hasProvider() Check if the channel has provider created
Object	invokeAction(EndpointIdentity targetIdentity, String action, Object actionPayload, org.json.JSONObject senderIdentity)
void	processConnection(org.json.JSONObject payload)
boolean	removeChannelListener(ChannelListener listener)
void	removeEventListener(String type, EventListener listener, AckListener callback) Removes a previously registered event listener from the specified event

Methods inherited from class java.lang.Object

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

Constructor Detail

Channel

public Channel(String name,
               DesktopConnection desktopConnection)

Method Detail

getName

public String getName()

Get the name of the channel

Returns:

name of the channel

getDesktopConnection

public DesktopConnection getDesktopConnection()

createAsync

public CompletionStage<ChannelProvider> createAsync()

create

public void create(AsyncCallback<ChannelProvider> callback)

Create a new channel.

Parameters:

callback - The callback that receives the wrapped ChannelProvider object

connectAsync

public CompletionStage<ChannelClient> connectAsync()

Connect to a channel provider

Returns:

A new CompletionStage for the client client

connectAsync

public CompletionStage<ChannelClient> connectAsync(Object connectPayload)

Connect to a channel provider with a payload passed to the provider

Parameters:

connectPayload - connection payload

Returns:

A new CompletionStage for the channel client

connectAsync

public CompletionStage<ChannelClient> connectAsync(Boolean noWait,
                                                   Object connectPayload)

Connect to a channel provider with a payload passed to the provider

Parameters:

noWait - if true, the request will fail if the provider is not running

connectPayload - connection payload

Returns:

A new CompletionStage for the client client

connect

public void connect(AsyncCallback<ChannelClient> callback)

Connect to the channel.

Parameters:

callback - The callback that receives the wrapped ChannelClient object

hasProvider

public boolean hasProvider()

Check if the channel has provider created

Returns:

if the channel provider exists.

hasClient

public boolean hasClient()

Check if the channel has client connected

Returns:

true if a channel client exists

invokeAction

public Object invokeAction(EndpointIdentity targetIdentity,
                           String action,
                           Object actionPayload,
                           org.json.JSONObject senderIdentity)

addChannelListener

public boolean addChannelListener(ChannelListener listener)

removeChannelListener

public boolean removeChannelListener(ChannelListener listener)

fireChannelConnectEvent

protected void fireChannelConnectEvent(ConnectionEvent event)

fireChannelDisconnectEvent

protected void fireChannelDisconnectEvent(ConnectionEvent event)

processConnection

public void processConnection(org.json.JSONObject payload)
                       throws Exception

Throws:

Exception

addEventListener

protected void addEventListener(org.json.JSONObject subscriptionObject,
                                EventListener listener,
                                AckListener callback)
                         throws DesktopException

Registers an event listener on the specified event

     Supported system event types are:
 

Parameters:

subscriptionObject - A JSON object containing subscription information such as the topic and type

listener - EventListener for the event

callback - AckListener for the request

Throws:

DesktopException - if this method fails to add event listener specified

See Also:

EventListener, AckListener

addEventListener

public void addEventListener(String type,
                             EventListener listener,
                             AckListener callback)
                      throws DesktopException

Registers an event listener on the specified event

     Supported system event types are:
 

Parameters:

type - Type of the event

listener - EventListener for the event

callback - AckListener for the request

Throws:

DesktopException - if this method fails to add event listener specified

See Also:

EventListener, AckListener

removeEventListener

public void removeEventListener(String type,
                                EventListener listener,
                                AckListener callback)
                         throws DesktopException

Removes a previously registered event listener from the specified event

Parameters:

type - Type of the event

listener - EventListener for the event

callback - AckListener for the request

Throws:

DesktopException - if this method fails to remove event listener specified

See Also:

DesktopException, EventListener, AckListener