Class PusherBroadcastClient

Implements

BroadcastClient

Index

Constructors

Methods

buildResolvedChannelName connect disconnect isConnected subscribe subscribeToUser

Constructors

constructor

new PusherBroadcastClient(
    pusher: Pusher,
    channelPrefix?: string,
    channelTypes?: ChannelTypeConfig,
): PusherBroadcastClient
Parameters
- pusher: Pusher
- OptionalchannelPrefix: string
- OptionalchannelTypes: ChannelTypeConfig
Returns PusherBroadcastClient
- Defined in packages/js-web-adapter-core/dist/index.d.ts:439
new PusherBroadcastClient(
    config: PusherConfig,
    channelPrefix?: string,
    channelTypes?: ChannelTypeConfig,
): PusherBroadcastClient
Parameters
- config: PusherConfig
- OptionalchannelPrefix: string
- OptionalchannelTypes: ChannelTypeConfig
Returns PusherBroadcastClient
- Defined in packages/js-web-adapter-core/dist/index.d.ts:440

Methods

`Protected`buildResolvedChannelName

buildResolvedChannelName(threadId: string): Promise<string>
Parameters
- threadId: string
Returns Promise<string>
- Defined in packages/js-web-adapter-core/dist/index.d.ts:442

connect

connect(): void
Returns void
Implementation of BroadcastClient.connect
- Defined in packages/js-web-adapter-core/dist/index.d.ts:444

disconnect

disconnect(): void
Returns void
Implementation of BroadcastClient.disconnect
- Defined in packages/js-web-adapter-core/dist/index.d.ts:445

isConnected

isConnected(): boolean
Returns boolean
Implementation of BroadcastClient.isConnected
- Defined in packages/js-web-adapter-core/dist/index.d.ts:448

subscribe(threadId: string, handlers: EventHandlers): Promise<Unsubscribe>
Parameters
- threadId: string
- handlers: EventHandlers
Returns Promise<Unsubscribe>
Implementation of BroadcastClient.subscribe
- Defined in packages/js-web-adapter-core/dist/index.d.ts:446

subscribeToUser

subscribeToUser(
    threadId: string,
    userId: string,
    handlers: EventHandlers,
): Promise<Unsubscribe>
Parameters
- threadId: string
- userId: string
- handlers: EventHandlers
Returns Promise<Unsubscribe>
Implementation of BroadcastClient.subscribeToUser
- Defined in packages/js-web-adapter-core/dist/index.d.ts:447