Class WebviewBot

Hierarchy

WebviewBot

Implements

SociablyBot<WebviewDispatchChannel, WebSocketJob, WebSocketResult>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebviewBot(server: WebviewSocketServer<AnyServerAuthenticator>, initScope?: InitScopeFn, dispatchWrapper?: DispatchWrapper<WebSocketJob, WebviewDispatchFrame, WebSocketResult>): WebviewBot

- Defined in packages/webview/src/bot.ts:65
Parameters
- server: WebviewSocketServer<AnyServerAuthenticator>
- Optional initScope: InitScopeFn
- Optional dispatchWrapper: DispatchWrapper<WebSocketJob, WebviewDispatchFrame, WebSocketResult>
Returns WebviewBot

Properties

engine

engine: default<WebviewDispatchChannel, EventInput, WebviewComponent, WebSocketJob, WebSocketResult>

platform

platform: "webview" = WEBVIEW

Methods

disconnect

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

- Defined in packages/webview/src/bot.ts:157
Parameters
- connection: WebviewConnection
- Optional reason: string
Returns Promise<boolean>

render

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

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

send

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

- Defined in packages/webview/src/bot.ts:116
Parameters
- channel: WebviewConnection
- content: EventInput | EventInput[]
Returns Promise<SendResult>

sendTopic

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

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

sendUser

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

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

start

start(): Promise<void>

- Defined in packages/webview/src/bot.ts:95
Returns Promise<void>

stop

stop(): Promise<void>

- Defined in packages/webview/src/bot.ts:100
Returns Promise<void>

subscribeTopic

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

- Defined in packages/webview/src/bot.ts:161
Parameters
- connection: WebviewConnection
- topic: string
Returns Promise<boolean>

unsubscribeTopic

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

- Defined in packages/webview/src/bot.ts:168
Parameters
- connection: WebviewConnection
- topic: string
Returns Promise<boolean>

Generated using TypeDoc