Interface ChannelDispatchHost

How the dispatcher reaches the session's channels.

interface ChannelDispatchHost {
    ActivateChannel(plugin: BaseRealtimeChannelClient): Promise<void>;
    FindChannel(key: string): DispatchableChannel | null;
    ListChannelKeys(): string[];
}

Index

Methods

ActivateChannel FindChannel ListChannelKeys

Methods

ActivateChannel

ActivateChannel(plugin: BaseRealtimeChannelClient): Promise<void>
Mounts an unopened on-demand channel (initialize, publish, tab). Resolves when it is live.
Parameters
- plugin: BaseRealtimeChannelClient
Returns Promise<void>
- Defined in channels/channel-action-dispatcher.ts:59

FindChannel

FindChannel(key: string): DispatchableChannel | null
Finds a channel in the session by key (case-insensitive), open or not; null when it is not in the session.
Parameters
- key: string
Returns DispatchableChannel | null
- Defined in channels/channel-action-dispatcher.ts:55

ListChannelKeys

ListChannelKeys(): string[]
The keys of every channel in the session, for error messages.

Returns string[]
- Defined in channels/channel-action-dispatcher.ts:57