Class ChatInstance

ChatInstance

Implements

Implementation of a single chat instance

Index

Constructors

Properties

beginChat callbacks clientId onDispose payload swarmName

Methods

checkLastActivity dispose listenDispose sendMessage

Constructors

constructor

new ChatInstance<Payload extends unknown = any>(): ChatInstance
Type Parameters
- Payload extends unknown = any
Returns ChatInstance
- Defined in types.d.ts:13376

Properties

beginChat

beginChat: () => Promise<void> & ISingleshotClearable

Begins a chat session

`Readonly`callbacks

callbacks: Partial<IChatInstanceCallbacks>

`Readonly`clientId

clientId: string

`Readonly`onDispose

onDispose: DisposeFn

`Readonly`payload

payload: Payload

`Readonly`swarmName

swarmName: string

Methods

checkLastActivity

checkLastActivity(now: number): Promise<boolean>
Checks if the chat has been active within the timeout period
Parameters
- now: number
Returns Promise<boolean>
- Defined in types.d.ts:13391

dispose

dispose(): Promise<void>
Disposes of the chat instance

Returns Promise<void>
- Defined in types.d.ts:13403

listenDispose

listenDispose(fn: (clientId: string) => void): () => void
Adds a listener for dispose events
Parameters
- fn: (clientId: string) => void
Returns () => void
- Defined in types.d.ts:13407

sendMessage

sendMessage(content: string): Promise<string>
Sends a message in the chat
Parameters
- content: string
Returns Promise<string>
- Defined in types.d.ts:13399