Class ChannelProvider

Hierarchy

ChannelBase
- ChannelProvider

Index

Constructors

Accessors

Methods

afterAction beforeAction destroy dispatch getAllClientInfo onConnection onDisconnection onError processConnection publish register remove setDefaultAction handleClientDisconnection setProviderRemoval

Constructors

constructor

new ChannelProvider(providerIdentity: ProviderIdentity, wire: Transport<EntityType>, strategy: AnyStrategy): OpenFin.ChannelProvider
Parameters
- providerIdentity: ProviderIdentity
- wire: Transport<EntityType>
- strategy: AnyStrategy
Returns OpenFin.ChannelProvider

Overrides ChannelBase.constructor

Accessors

connections

get connections(): ClientConnectionPayload[]
Returns ClientConnectionPayload[]

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

destroy

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

dispatch

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

getAllClientInfo

getAllClientInfo(): Promise<ClientInfo[]>
Returns Promise<ClientInfo[]>

onConnection

onConnection(listener: ConnectionListener): void
Parameters
- listener: ConnectionListener
Returns void

onDisconnection

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

onError

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

Inherited from ChannelBase.onError

processConnection

processConnection(senderId: ClientConnectionPayload, payload: any): Promise<any>
Parameters
- senderId: ClientConnectionPayload
- payload: any
Returns Promise<any>

publish

publish(action: string, payload: any): Promise<any>[]
Parameters
- action: string
- payload: any
Returns Promise<any>[]

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

setDefaultAction

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

Inherited from ChannelBase.setDefaultAction

`Static` handleClientDisconnection

handleClientDisconnection(channel: OpenFin.ChannelProvider, payload: any): void
Parameters
- channel: OpenFin.ChannelProvider
- payload: any
Returns void

`Static` setProviderRemoval

setProviderRemoval(provider: OpenFin.ChannelProvider, remove: Function): void
Parameters
- provider: OpenFin.ChannelProvider
- remove: Function
Returns void

Generated using TypeDoc