Class WebSocketBot

Hierarchy

WebSocketBot

Implements

SociablyBot<WebSocketDispatchChannel, WebSocketJob, WebSocketResult>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebSocketBot(server: ServerP<any, unknown>, initScope?: InitScopeFn, dispatchWrapper?: DispatchWrapper<WebSocketJob, WebSocketDispatchFrame, WebSocketResult>): WebSocketBot

- Defined in packages/websocket/src/bot.ts:60
Parameters
- server: ServerP<any, unknown>
- Optional initScope: InitScopeFn
- Optional dispatchWrapper: DispatchWrapper<WebSocketJob, WebSocketDispatchFrame, WebSocketResult>
Returns WebSocketBot

Properties

engine

engine: default<WebSocketDispatchChannel, EventInput, WebSocketComponent, WebSocketJob, WebSocketResult>

platform

platform: "websocket" = WEBSOCKET

Methods

disconnect

disconnect(connection: WebSocketConnection, reason?: string): Promise<boolean>

- Defined in packages/websocket/src/bot.ts:164
Parameters
- connection: WebSocketConnection
- Optional reason: string
Returns Promise<boolean>

render

render(channel: WebSocketDispatchChannel, message: SociablyNode): Promise<null | WebSocketDispatchResponse>

Implementation of SociablyBot.render
- Defined in packages/websocket/src/bot.ts:103
Parameters
- channel: WebSocketDispatchChannel
- message: SociablyNode
Returns Promise<null | WebSocketDispatchResponse>

send

send(channel: WebSocketConnection, content: EventInput | EventInput[]): Promise<SendResult>

- Defined in packages/websocket/src/bot.ts:114
Parameters
- channel: WebSocketConnection
- content: EventInput | EventInput[]
Returns Promise<SendResult>

sendTopic

sendTopic(topic: string, content: EventInput | EventInput[]): Promise<SendResult>

- Defined in packages/websocket/src/bot.ts:147
Parameters
- topic: string
- content: EventInput | EventInput[]
Returns Promise<SendResult>

sendUser

sendUser(user: SociablyUser, content: EventInput | EventInput[]): Promise<SendResult>

- Defined in packages/websocket/src/bot.ts:130
Parameters
- user: SociablyUser
- content: EventInput | EventInput[]
Returns Promise<SendResult>

start

start(): Promise<void>

- Defined in packages/websocket/src/bot.ts:93
Returns Promise<void>

stop

stop(): Promise<void>

- Defined in packages/websocket/src/bot.ts:98
Returns Promise<void>

subscribeTopic

subscribeTopic(connection: WebSocketConnection, topic: string): Promise<boolean>

- Defined in packages/websocket/src/bot.ts:171
Parameters
- connection: WebSocketConnection
- topic: string
Returns Promise<boolean>

unsubscribeTopic

unsubscribeTopic(connection: WebSocketConnection, topic: string): Promise<boolean>

- Defined in packages/websocket/src/bot.ts:178
Parameters
- connection: WebSocketConnection
- topic: string
Returns Promise<boolean>

Generated using TypeDoc