bothy-sdk
    Preparing search index...

    Interface OutboxEntry

    One stored write.

    interface OutboxEntry {
        entryId: number;
        key: string;
        kind: OutboxEntryKind;
        payload: Readonly<Record<string, unknown>>;
        problemCode?: string;
        runId?: string;
        state: OutboxState;
        threadId: string;
    }
    Index

    Properties

    entryId key kind payload problemCode? runId? state threadId

    Properties

    entryId: number

    The order of the entry (ascending per store; 0 before it is stored).

    key: string

    The client_msg_id of a reply or the Idempotency-Key of a call.

    kind: OutboxEntryKind

    message (a reply) or call (another write).

    payload: Readonly<Record<string, unknown>>

    The stored request: the MessageCreate body of a reply, or method, path, parameters and body of a call. Plain JSON.

    problemCode?: string

    The problem code of a failed entry.

    runId?: string

    The run whose binding the write goes out under (07 SR9): the run passed by the caller or, when none was passed, the run the client was bound to when the entry was stored; absent for a write made outside any run.

    state: OutboxState

    Pending, sent or failed.

    threadId: string

    The thread whose order it keeps (FIFO).

    Settings

    Member Visibility

    On This Page

    Properties