Channel | Flywheel Extension SDK

Hierarchy

Channel

Index

Constructors

constructor

Properties

messages$

Methods

Constructors

constructor

new Channel(options?: ChannelOptions): Channel

- Defined in src/channel.ts:18
Parameters
- Default value options: ChannelOptions = {}
Returns Channel

Properties

messages$

messages$: Observable<ChannelMessage> = this.messages.asObservable()

Methods

connect

connect(): void

- Defined in src/channel.ts:48
Request a connection to channel instance listening in the sendWindow.

Returns void

destroy

destroy(): void

- Defined in src/channel.ts:40
Stop listening for messages and shut down the message stream.

Returns void

send

send(method: string, params?: any, queryId?: MessageID): MessageID

- Defined in src/channel.ts:71
Send a message through the channel.

Parameters
- method: string
  
  An identifier that the target can map to a specific action
- Default value params: any = {}
  
  Arguments for the method
- Optional queryId: MessageID
  
  ID of a previous message that this message is responding to
Returns MessageID

Generated using TypeDoc