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

    Interface TriggerOptions

    interface TriggerOptions {
        chatId: string;
        userId?: string;
        isGroup?: boolean;
        data?: Record<string, unknown>;
        ifActive?: "skip" | "replace";
        body?: string;
    }
    Index
    chatId userId? isGroup? data? ifActive? body?
    chatId: string

    Chat to run the conversation in (an opaque transport id, used as-is).

    userId?: string

    Subject of the conversation (default: chatId). Required to target one participant of a group.

    isGroup?: boolean

    Is chatId a group? (default false). With conversationScope: 'participant' it keys the conversation per userId.

    data?: Record<string, unknown>

    Seeds c.state (shallow copy) — e.g. { cita: 'mañana 3pm' } → c.state.cita.

    ifActive?: "skip" | "replace"

    What to do when the subject already has a live conversation or a dormant (persisted) checkpoint: 'skip' (default) leaves it alone and resolves { started: false, reason: 'busy' }; 'replace' cancels it and starts this one.

    Optionalbody

    body?: string

    ctx.body of the synthetic triggering message (default '').

    Settings
    Member Visibility

    On This Page
    Properties