Package com.openfin.desktop.fdc3

Class FDC3Client

java.lang.Object

com.openfin.desktop.channel.AbstractServiceClient

com.openfin.desktop.fdc3.FDC3Client

public class FDC3Client
extends AbstractServiceClient

Field Summary

Fields inherited from class com.openfin.desktop.channel.AbstractServiceClient

channelClient, channelName, desktopConnection, logger

Method Summary

Modifier and Type	Method	Description
void	addContextListener(ContextListener callback, AckListener ackListener)	Adds a listener for incoming context broadcast from the Desktop Agent.
void	addIntentListener(java.lang.String intent, IntentListener listener, AckListener ackListener)	Adds a listener for incoming Intents from the Agent.
void	broadcast(Context context, AckListener ackListener)	Publishes context to other apps on the desktop.
void	connect(AckListener ackListener)
void	findIntent(java.lang.String intent, Context context, AsyncCallback<AppIntent> callback)	Find out more information about a particular intent by passing its name, and optionally its context.
void	findIntentsByContext(Context context, AsyncCallback<java.util.List<AppIntent>> callback)	Find all the avalable intents for a particular context.
void	getChannelById(java.lang.String id, AsyncCallback<Channel> callback)
void	getDefaultChannel(AsyncCallback<Channel> callback)
static FDC3Client	getInstance(DesktopConnection desktopConnection)
protected void	onChannelConnected()
void	open(java.lang.String name, Context context, AckListener ackListener)	Launches/links to an application by name.
void	raiseIntent(java.lang.String intent, Context context, java.lang.String target, AsyncCallback<IntentResolution> callback)	Raises an intent to the desktop agent to resolve.
boolean	removeContextListener(ContextListener listener)

Methods inherited from class com.openfin.desktop.channel.AbstractServiceClient

setChannelName

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FDC3Client getInstance(DesktopConnection desktopConnection)

connect

public void connect(AckListener ackListener)

Overrides:

connect in class AbstractServiceClient

open

public void open(java.lang.String name,
                 Context context,
                 AckListener ackListener)

Launches/links to an application by name.

Parameters:

name - Application name

context - Context object that will be provided to the opened application via a contextListener

ackListener - AckListener for the request

broadcast

public void broadcast(Context context,
                      AckListener ackListener)

Publishes context to other apps on the desktop.

Parameters:

context - Context object

ackListener - AckListener for the request

findIntent

public void findIntent(java.lang.String intent,
                       Context context,
                       AsyncCallback<AppIntent> callback)

Find out more information about a particular intent by passing its name, and optionally its context.

Parameters:

intent - Intent name

context - Context Object

callback - AckListener for the request

findIntentsByContext

public void findIntentsByContext(Context context,
                                 AsyncCallback<java.util.List<AppIntent>> callback)

Find all the avalable intents for a particular context.

Parameters:

context - Context Object

callback - AckListener for the request

raiseIntent

public void raiseIntent(java.lang.String intent,
                        Context context,
                        java.lang.String target,
                        AsyncCallback<IntentResolution> callback)

Raises an intent to the desktop agent to resolve.

Parameters:

intent - Intent name

context - Context object

target - Raise the intent to specified target.

callback - The callback that receives the wrapped IntentResolution object

onChannelConnected

protected void onChannelConnected()

Overrides:

onChannelConnected in class AbstractServiceClient

addContextListener

public void addContextListener(ContextListener callback,
                               AckListener ackListener)

Adds a listener for incoming context broadcast from the Desktop Agent.

Parameters:

callback - The context listener

ackListener - AckListener for the request

removeContextListener

public boolean removeContextListener(ContextListener listener)

addIntentListener

public void addIntentListener(java.lang.String intent,
                              IntentListener listener,
                              AckListener ackListener)

Adds a listener for incoming Intents from the Agent.

Parameters:

intent - Intent name

listener - The intent listener

ackListener - AckListener for the request

getChannelById

public void getChannelById(java.lang.String id,
                           AsyncCallback<Channel> callback)

getDefaultChannel

public void getDefaultChannel(AsyncCallback<Channel> callback)