Interface IWidgetTransport

Abstraction over "start a conversation and exchange turns with the pinned agent." One transport instance per mounted widget session.

interface IWidgetTransport {
    Dispose(): Promise<void>;
    Initialize(session: WidgetSession): Promise<void>;
    SendMessage(
        text: string,
        onProgress?: WidgetProgressCallback,
    ): Promise<WidgetTurnResult>;
    UpdateToken(token: string): void;
}

Implemented by

Index

Methods

Dispose Initialize SendMessage UpdateToken

Methods

Dispose

Dispose(): Promise<void>
Tears down the conversation/session resources.

Returns Promise<void>
- Defined in packages/Web/RealtimeWidget/src/transport/widget-transport.ts:46

Initialize

Initialize(session: WidgetSession): Promise<void>
Initializes the transport with the freshly-minted guest session.
Parameters
- session: WidgetSession
Returns Promise<void>
- Defined in packages/Web/RealtimeWidget/src/transport/widget-transport.ts:33

SendMessage

SendMessage(
text: string,
onProgress?: WidgetProgressCallback,
): Promise<WidgetTurnResult>
Sends a user message and resolves with the agent's reply. The pinned agent id from the session is ALWAYS passed as explicitAgentId (D5) — the transport never lets the caller pick an arbitrary agent.
Parameters
- text: string
- OptionalonProgress: WidgetProgressCallback
Returns Promise<WidgetTurnResult>
- Defined in packages/Web/RealtimeWidget/src/transport/widget-transport.ts:43

UpdateToken

UpdateToken(token: string): void
Updates the held token after a refresh (no reconnection of the conversation).
Parameters
- token: string
Returns void
- Defined in packages/Web/RealtimeWidget/src/transport/widget-transport.ts:36