@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface ConversationEndedEvent

    Payload of the bot 'conversation:ended' event.

    interface ConversationEndedEvent {
        id: string;
        name: string;
        chatId: string;
        userId: string;
        key: string;
        outcome: ConversationOutcome;
        completed: boolean;
        durationMs: number;
        goto?: string;
    }

    Hierarchy (View Summary)

    Index
    id name chatId userId key outcome completed durationMs goto?
    id: string

    Unique per conversation instance — matches a 'conversation:ended' to its 'conversation:started'.

    name: string

    Conversation/flow name.

    chatId: string
    userId: string
    key: string

    Runtime key (chatId, or chatId:userId per group participant).

    outcome: ConversationOutcome
    completed: boolean

    Shorthand for outcome === 'completed'.

    durationMs: number
    goto?: string

    Target of the c.goto() that ended it, if any (a new 'conversation:started' follows).

    Settings
    Member Visibility

    On This Page
    Properties