Class Channel

Hierarchy

EmitterBase<ChannelEvent>
- Channel

Index

Constructors

Properties

addListener wire

Accessors

Methods

connect create emit eventNames getAllChannels listenerCount listeners on onChannelConnect onChannelDisconnect once prependListener prependOnceListener removeAllListeners removeListener

Constructors

constructor

new Channel(wire: Transport<EntityType>): Channel
Parameters
- wire: Transport<EntityType>
Returns Channel

Overrides EmitterBase<ChannelEvent>.constructor

Properties

addListener

addListener: (<EventType>(eventType: EventType, listener: EventHandler<ChannelEvent, EventType>, options?: SubscriptionOptions) => Promise<Channel>) = ...

Type declaration

- <EventType>(eventType: EventType, listener: EventHandler<ChannelEvent, EventType>, options?: SubscriptionOptions): Promise<Channel>
- Type Parameters
  - EventType extends "connected" | "disconnected"
  Parameters
  - eventType: EventType
  - listener: EventHandler<ChannelEvent, EventType>
  - Optional options: SubscriptionOptions
  Returns Promise<Channel>

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from EmitterBase.me

Methods

connect

connect(channelName: string, options?: ChannelConnectOptions): Promise<OpenFin.ChannelClient>
Parameters
- channelName: string
- options: ChannelConnectOptions = {}
Returns Promise<OpenFin.ChannelClient>

create

create(channelName: string, options?: ChannelCreateOptions): Promise<OpenFin.ChannelProvider>
Parameters
- channelName: string
- Optional options: ChannelCreateOptions
Returns Promise<OpenFin.ChannelProvider>

emit

emit<EventType>(eventType: EventType, payload: Extract<EmitterEvent, {
type: EventType;
}>, ...args: any[]): boolean
Type Parameters
- EventType extends string
Parameters
- eventType: EventType
- payload: Extract<EmitterEvent, {
  type: EventType;
  }>
- Rest ...args: any[]
Returns boolean

Inherited from EmitterBase.emit

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]

Inherited from EmitterBase.eventNames

getAllChannels

getAllChannels(): Promise<ProviderIdentity[]>
Returns Promise<ProviderIdentity[]>

listenerCount

listenerCount(type: string | symbol): number
Parameters
- type: string | symbol
Returns number

Inherited from EmitterBase.listenerCount

listeners

listeners(type: string | symbol): Function[]
Parameters
- type: string | symbol
Returns Function[]

Inherited from EmitterBase.listeners

on

on<EventType>(eventType: EventType, listener: EventHandler<ChannelEvent, EventType>, options?: SubscriptionOptions): Promise<Channel>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<ChannelEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Channel>

Inherited from EmitterBase.on

onChannelConnect

onChannelConnect(listener: ((...args: any[]) => void)): Promise<void>
Parameters
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Promise<void>

onChannelDisconnect

onChannelDisconnect(listener: ((...args: any[]) => void)): Promise<void>
Parameters
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Promise<void>

once

once<EventType>(eventType: EventType, listener: EventHandler<ChannelEvent, EventType>, options?: SubscriptionOptions): Promise<Channel>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<ChannelEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Channel>

Inherited from EmitterBase.once

prependListener

prependListener<EventType>(eventType: EventType, listener: EventHandler<ChannelEvent, EventType>, options?: SubscriptionOptions): Promise<Channel>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<ChannelEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Channel>

Inherited from EmitterBase.prependListener

prependOnceListener

prependOnceListener<EventType>(eventType: EventType, listener: EventHandler<ChannelEvent, EventType>, options?: SubscriptionOptions): Promise<Channel>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<ChannelEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Channel>

Inherited from EmitterBase.prependOnceListener

removeAllListeners

removeAllListeners(eventType?: "connected" | "disconnected"): Promise<Channel>
Parameters
- Optional eventType: "connected" | "disconnected"
Returns Promise<Channel>

Inherited from EmitterBase.removeAllListeners

removeListener

removeListener<EventType>(eventType: EventType, listener: EventHandler<ChannelEvent, EventType>, options?: SubscriptionOptions): Promise<Channel>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<ChannelEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<Channel>

Inherited from EmitterBase.removeListener

Generated using TypeDoc