Class ChannelClient

Hierarchy

ChannelBase
- ChannelClient

Index

Constructors

Accessors

providerIdentity

Methods

afterAction beforeAction disconnect dispatch onDisconnection onError register remove sendDisconnectAction setDefaultAction closeChannelByEndpointId handleProviderDisconnect

Constructors

constructor

new ChannelClient(routingInfo: RoutingInfo, wire: Transport<EntityType>, strategy: AnyStrategy): OpenFin.ChannelClient
Parameters
- routingInfo: RoutingInfo
- wire: Transport<EntityType>
- strategy: AnyStrategy
Returns OpenFin.ChannelClient

Overrides ChannelBase.constructor

Accessors

providerIdentity

get providerIdentity(): ProviderIdentity
Returns ProviderIdentity

Methods

afterAction

afterAction(func: ChannelMiddleware): void
Parameters
- func: ChannelMiddleware
Returns void

Inherited from ChannelBase.afterAction

beforeAction

beforeAction(func: ChannelMiddleware): void
Parameters
- func: ChannelMiddleware
Returns void

Inherited from ChannelBase.beforeAction

disconnect

disconnect(): Promise<void>
Returns Promise<void>

dispatch

dispatch(action: string, payload?: any): Promise<any>
Parameters
- action: string
- Optional payload: any
Returns Promise<any>

onDisconnection

onDisconnection(listener: DisconnectionListener): void
Parameters
- listener: DisconnectionListener
Returns void

onError

onError(func: ErrorMiddleware): void
Parameters
- func: ErrorMiddleware
Returns void

Inherited from ChannelBase.onError

register

register(topic: string, listener: ChannelAction): boolean
Parameters
- topic: string
- listener: ChannelAction
Returns boolean

Inherited from ChannelBase.register

remove

remove(action: string): void
Parameters
- action: string
Returns void

Inherited from ChannelBase.remove

sendDisconnectAction

sendDisconnectAction(): Promise<void>
Returns Promise<void>

setDefaultAction

setDefaultAction(func: ChannelMiddleware): void
Parameters
- func: ChannelMiddleware
Returns void

Inherited from ChannelBase.setDefaultAction

`Static` closeChannelByEndpointId

closeChannelByEndpointId(id: string): void
Parameters
- id: string
Returns void

`Static` handleProviderDisconnect

handleProviderDisconnect(eventPayload: ProviderIdentity): void
Parameters
- eventPayload: ProviderIdentity
Returns void

Generated using TypeDoc