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

    Interface FormStepOptions

    Options of flow().form(definition, opts).

    interface FormStepOptions {
        stateKey?: string;
        flatten?: boolean;
        mode?: FormMode;
        nativeId?: string;
        timeout?: string | number;
        maxAttempts?: number;
        retries?: number;
        skipWord?: string;
        pendingMessage?: string;
    }
    Index
    stateKey? flatten? mode? nativeId? timeout? maxAttempts? retries? skipWord? pendingMessage?
    stateKey?: string

    c.state key the answers object is stored under. Default: the form id.

    flatten?: boolean

    Also copy every answer to c.state[field.name]. Default false.

    mode?: FormMode

    Force a rendering mode. Default 'auto'.

    nativeId?: string

    Provider-side id of the published native form (on the Cloud API: a WhatsApp Flow id, or its name). Providers may also map definition.id to it in their config.

    timeout?: string | number

    Wait timeout per answer (degraded) / for the whole submission (native). Default: the flow's.

    maxAttempts?: number

    Total answers accepted per field (degraded) or submissions (native), the first included. Default 3.

    retries?: number

    Retries after the first answer (retries: N = maxAttempts: N + 1). Breaking in 2.0: it meant total attempts (without maxAttempts, the bot warns once).

    skipWord?: string

    Degraded mode: word that skips an optional field. Default: the locale's core.form.skipWord ('skip' in English, 'omitir' in Spanish).

    pendingMessage?: string

    Native mode: reply sent when the user writes instead of submitting the form.

    Settings
    Member Visibility

    On This Page
    Properties