Interface IChatInstance

IChatInstance

Description

Interface for chat instance functionality

interface IChatInstance {
    beginChat(): Promise<void>;
    checkLastActivity(now: number): Promise<boolean>;
    dispose(): Promise<void>;
    listenDispose(fn: (clientId: string) => void): void;
    sendMessage(content: string): Promise<string>;
}

Methods

beginChat checkLastActivity dispose listenDispose sendMessage

Methods

beginChat

  • beginChat(): Promise<void>

    Begins a chat session

    Returns Promise<void>

checkLastActivity

  • checkLastActivity(now: number): Promise<boolean>

    Checks if the chat has been active within the timeout period

    Parameters

    • now: number

      Current timestamp

    Returns Promise<boolean>

    Whether the chat is still active

dispose

  • dispose(): Promise<void>

    Disposes of the chat instance

    Returns Promise<void>

listenDispose

  • listenDispose(fn: (clientId: string) => void): void

    Adds a listener for dispose events

    Parameters

    • fn: (clientId: string) => void

      Callback function to execute on dispose

    Returns void

sendMessage

  • sendMessage(content: string): Promise<string>

    Sends a message in the chat

    Parameters

    • content: string

      Message content to send

    Returns Promise<string>

    Response from the chat session

Settings

Member Visibility

On This Page

Methods