SoulFire TypeScript SDK 2.10.8
    Preparing search index...

    Type Alias BotSubmitDialogRequest

    BotSubmitDialogRequest: Message<"soulfire.v1.BotSubmitDialogRequest"> & {
        botId: string;
        buttonIndex?: number;
        expectedScreenId?: string;
        inputValues: { [key: string]: string };
        instanceId: string;
    }

    Request to submit a dialog with input values. Used for dialogs that have input fields requiring user data.

    Type Declaration

    • botId: string

      The profile UUID of the bot submitting the dialog.

      from field: string bot_id = 2;

    • OptionalbuttonIndex?: number

      Action index, defaulting to the first action. Use -1 to dismiss.

      from field: optional int32 button_index = 4;

    • OptionalexpectedScreenId?: string

      Reject the request if the active screen differs from this ServerDialog.screen_id.

      from field: optional string expected_screen_id = 5;

    • inputValues: { [key: string]: string }

      Map of input key to value for each input field. Keys must match the key field of DialogInput elements. Booleans use true/false, options use their IDs, and ranges use numeric text.

      from field: map<string, string> input_values = 3;

    • instanceId: string

      The UUID of the SoulFire instance containing the bot.

      from field: string instance_id = 1;

    from message soulfire.v1.BotSubmitDialogRequest