Class InteropClient

https://developers.openfin.co/of-docs/docs/enable-color-linking

The Interop Client API is broken up into two groups:

Content Facing APIs - For Application Developers putting Views into a Platform Window, who care about Context. These are APIs that send out and receive the Context data that flows between applications. Think of this as the Water in the Interop Pipes.

Context Grouping APIs - For Platform Developers, to add and remove Views to and from Context Groups. These APIs are utilized under-the-hood in Platforms, so they don't need to be used to participate in Interop. These are the APIs that decide which entities the context data flows between. Think of these as the valves or pipes that control the flow of Context Data for Interop.

All APIs are available at the fin.me.interop namespace.

You only need 2 things to participate in Interop Context Grouping:

A Context Handler for incoming context: addContextHandler(handler, contextType?)
Call setContext on your context group when you want to share context with other group members: setContext(context)

Hideconstructor

Hierarchy

Base
- InteropClient

Index

Constructors

constructor

Properties

wire

Accessors

Methods

addContextHandler fireIntent fireIntentForContext getAllClientsInContextGroup getContextGroups getCurrentContext getInfoForContextGroup getInfoForIntent getInfoForIntentsByContext joinContextGroup joinSessionContextGroup onDisconnection registerIntentHandler removeFromContextGroup setContext ferryFdc3Call

Constructors

constructor

new InteropClient(wire: Transport<EntityType>, name: string, interopConfig?: InteropConfig): OpenFin.InteropClient
Parameters
- wire: Transport<EntityType>
- name: string
- interopConfig: InteropConfig = {}
Returns OpenFin.InteropClient

Overrides Base.constructor

Properties

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from Base.me

Methods

addContextHandler

addContextHandler(handler: ContextHandler, contextType?: string): Promise<{
unsubscribe: (() => void);
}>
Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts.

Returns

Tutorial
interop.addContextHandler
Parameters
- handler: ContextHandler
  
  Handler for incoming context.
- Optional contextType: string
  
  The type of context you wish to handle.
Returns Promise<{
unsubscribe: (() => void);
}>

fireIntent

fireIntent<T>(intent: Intent<IntentMetadata<any>>): Promise<T>
Sends an intent to the Interop Broker to resolve.

Returns

Tutorial
interop.fireIntent
Type Parameters
- T = unknown
Parameters
- intent: Intent<IntentMetadata<any>>
  
  The combination of an action and a context that is passed to an application for resolution.
Returns Promise<T>

fireIntentForContext

fireIntentForContext<T>(context: ContextForIntent<any>): Promise<T>
Sends a Context that will be resolved to an Intent by the Interop Broker. This context accepts a metadata property.

Returns

Tutorial
interop.fireIntentForContext
Type Parameters
- T = unknown
Parameters
- context: ContextForIntent<any>
Returns Promise<T>

getAllClientsInContextGroup

getAllClientsInContextGroup(contextGroupId: string): Promise<ClientIdentity[]>
Gets all clients for a context group. Used by Platform Windows.

Returns

Tutorial
interop.getAllClientsInContextGroup
Parameters
- contextGroupId: string
  
  The id of context group you wish to get clients for.
Returns Promise<ClientIdentity[]>

getContextGroups

getContextGroups(): Promise<ContextGroupInfo[]>
Returns the Interop-Broker-defined context groups available for an entity to join. Used by Platform Windows.

Returns

Tutorial
interop.getContextGroups

Returns Promise<ContextGroupInfo[]>

getCurrentContext

getCurrentContext(contextType?: string): Promise<Context>
Gets the last context of the Context Group currently subscribed to. It takes an optional Context Type and returns the last context of that type.

Returns

Tutorial
interop.getCurrentContext
Parameters
- Optional contextType: string
Returns Promise<Context>

getInfoForContextGroup

getInfoForContextGroup(contextGroupId: string): Promise<undefined | ContextGroupInfo>
Gets display info for a context group Used by Platform Windows.

Returns

Tutorial
interop.getInfoForContextGroup
Parameters
- contextGroupId: string
  
  The id of context group you wish to get display info for.
Returns Promise<undefined | ContextGroupInfo>

getInfoForIntent

getInfoForIntent<T>(options: InfoForIntentOptions<IntentMetadata<any>>): Promise<T>
Get information for a particular Intent from the Interop Broker.

Returns

Tutorial
interop.getInfoForIntent
Type Parameters
- T = unknown
Parameters
- options: InfoForIntentOptions<IntentMetadata<any>>
Returns Promise<T>

getInfoForIntentsByContext

getInfoForIntentsByContext<T>(context: Context): Promise<T>
Get information from the Interop Broker on all Intents that are meant to handle a particular context.

Returns

Tutorial
interop.getInfoForIntentsByContext
Type Parameters
- T = unknown
Parameters
- context: Context
Returns Promise<T>

joinContextGroup

joinContextGroup(contextGroupId: string, target?: Identity): Promise<void>
Join all Interop Clients at the given identity to context group contextGroupId. If no target is specified, it adds the sender to the context group. Because multiple Channel connections/Interop Clients can potentially exist at a uuid/name combo, we currently join all Channel connections/Interop Clients at the given identity to the context group. If an endpointId is provided (which is unlikely, unless the call is coming from an external adapter), then we only join that single connection to the context group. For all intents and purposes, there will only be 1 connection present in Platform and Browser implmentations, so this point is more-or-less moot. Used by Platform Windows.

Returns

Tutorial
interop.joinContextGroup
Parameters
- contextGroupId: string
  
  Id of the context group.
- Optional target: Identity
  
  Identity of the entity you wish to join to a context group.
Returns Promise<void>

joinSessionContextGroup

joinSessionContextGroup(sessionContextGroupId: string): Promise<SessionContextGroup>
Join the current entity to session context group sessionContextGroupId and return a sessionContextGroup instance. If the sessionContextGroup doesn't exist, one will get created. Session Context Groups do not persist between runs and aren't present on snapshots.

Returns

Tutorial
interop.joinSessionContextGroup
Parameters
- sessionContextGroupId: string
  
  Id of the context group.
Returns Promise<SessionContextGroup>

onDisconnection

onDisconnection(listener: InteropClientOnDisconnectionListener): Promise<void>
Register a listener that is called when the Interop Client has been disconnected from the Interop Broker. Only one listener per Interop Client can be set.

Returns

Tutorial
interop.onDisconnection
Parameters
- listener: InteropClientOnDisconnectionListener
Returns Promise<void>

registerIntentHandler

registerIntentHandler(handler: IntentHandler, intentName: string, options?: any): Promise<{
unsubscribe: (() => Promise<void>);
}>
Adds an intent handler for incoming intents. The last intent sent of the name subscribed to will be received.

Returns

Tutorial
interop.registerIntentHandler
Parameters
- handler: IntentHandler
  
  Registered function meant to handle a specific intent type.
- intentName: string
  
  The name of an intent.
- Optional options: any
Returns Promise<{
unsubscribe: (() => Promise<void>);
}>

removeFromContextGroup

removeFromContextGroup(target?: Identity): Promise<void>
Removes the specified target from a context group. If no target is specified, it removes the sender from their context group. Used by Platform Windows.

Returns

Tutorial
interop.removeFromContextGroup
Parameters
- Optional target: Identity
  
  Identity of the entity you wish to join to a context group.
Returns Promise<void>

setContext

setContext(context: Context): Promise<void>
Sets a context for the context group of the current entity.

Returns

Tutorial
interop.setContext
Parameters
- context: Context
  
  New context to set.
Returns Promise<void>

`Static` ferryFdc3Call

ferryFdc3Call(interopClient: OpenFin.InteropClient, action: string, payload?: any): Promise<any>
Parameters
- interopClient: OpenFin.InteropClient
- action: string
- Optional payload: any
Returns Promise<any>

Class InteropClient

Constructor

Interop methods intended for Views

Interop methods intended for Windows

Hideconstructor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wire: Transport<EntityType>

name: string

interopConfig: InteropConfig = {}

Returns OpenFin.InteropClient

Properties

wire

Accessors

me

Returns Identity

Methods

addContextHandler

Returns

Tutorial

Parameters

handler: ContextHandler

Optional contextType: string

Returns Promise<{ unsubscribe: (() => void); }>

fireIntent

Returns

Tutorial

Type Parameters

T = unknown

Parameters

intent: Intent<IntentMetadata<any>>

Returns Promise<T>

fireIntentForContext

Returns

Tutorial

Type Parameters

T = unknown

Parameters

context: ContextForIntent<any>

Returns Promise<T>

getAllClientsInContextGroup

Returns

Tutorial

Parameters

contextGroupId: string

Returns Promise<ClientIdentity[]>

getContextGroups

Returns

Tutorial

Returns Promise<ContextGroupInfo[]>

getCurrentContext

Returns

Tutorial

Parameters

Optional contextType: string

Returns Promise<Context>

getInfoForContextGroup

Returns

Tutorial

Parameters

contextGroupId: string

Returns Promise<undefined | ContextGroupInfo>

getInfoForIntent

Returns

Tutorial

Type Parameters

T = unknown

Parameters

options: InfoForIntentOptions<IntentMetadata<any>>

Returns Promise<T>

getInfoForIntentsByContext

Returns

Tutorial

`Optional` contextType: string

Returns Promise<{
unsubscribe: (() => void);
}>

`Optional` contextType: string

`Optional` target: Identity

`Optional` options: any

Returns Promise<{
unsubscribe: (() => Promise<void>);
}>

`Optional` target: Identity

`Static` ferryFdc3Call

`Optional` payload: any