gbox-sdk
    Preparing search index...

    Interface ActionPressKey

    interface ActionPressKey {
        includeScreenshot?: boolean;
        keys: (
            | "delete"
            | "0"
            | "shift"
            | ";"
            | "o"
            | "="
            | ","
            | "."
            | "["
            | "]"
            | "a"
            | "b"
            | "c"
            | "d"
            | "e"
            | "f"
            | "g"
            | "h"
            | "i"
            | "j"
            | "k"
            | "l"
            | "m"
            | "n"
            | "p"
            | "q"
            | "r"
            | "s"
            | "t"
            | "u"
            | "v"
            | "w"
            | "x"
            | "y"
            | "z"
            | "1"
            | "2"
            | "3"
            | "4"
            | "5"
            | "6"
            | "7"
            | "8"
            | "9"
            | "f1"
            | "f2"
            | "f3"
            | "f4"
            | "f5"
            | "f6"
            | "f7"
            | "f8"
            | "f9"
            | "f10"
            | "f11"
            | "f12"
            | "control"
            | "alt"
            | "meta"
            | "win"
            | "cmd"
            | "option"
            | "arrowUp"
            | "arrowDown"
            | "arrowLeft"
            | "arrowRight"
            | "home"
            | "end"
            | "pageUp"
            | "pageDown"
            | "enter"
            | "space"
            | "tab"
            | "escape"
            | "backspace"
            | "insert"
            | "capsLock"
            | "numLock"
            | "scrollLock"
            | "pause"
            | "printScreen"
            | "-"
            | "/"
            | "`"
            | "\\"
            | "'"
            | "numpad0"
            | "numpad1"
            | "numpad2"
            | "numpad3"
            | "numpad4"
            | "numpad5"
            | "numpad6"
            | "numpad7"
            | "numpad8"
            | "numpad9"
            | "numpadAdd"
            | "numpadSubtract"
            | "numpadMultiply"
            | "numpadDivide"
            | "numpadDecimal"
            | "numpadEnter"
            | "numpadEqual"
            | "volumeUp"
            | "volumeDown"
            | "volumeMute"
            | "mediaPlayPause"
            | "mediaStop"
            | "mediaNextTrack"
            | "mediaPreviousTrack"
        )[];
        outputFormat?: "base64"
        | "storageKey";
        screenshotDelay?:
            | `${number}h`
            | `${number}m`
            | `${number}s`
            | `${number}ms`;
    }

    Hierarchy (View Summary)

    Index

    Properties

    includeScreenshot?: boolean

    Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

    keys: (
        | "delete"
        | "0"
        | "shift"
        | ";"
        | "o"
        | "="
        | ","
        | "."
        | "["
        | "]"
        | "a"
        | "b"
        | "c"
        | "d"
        | "e"
        | "f"
        | "g"
        | "h"
        | "i"
        | "j"
        | "k"
        | "l"
        | "m"
        | "n"
        | "p"
        | "q"
        | "r"
        | "s"
        | "t"
        | "u"
        | "v"
        | "w"
        | "x"
        | "y"
        | "z"
        | "1"
        | "2"
        | "3"
        | "4"
        | "5"
        | "6"
        | "7"
        | "8"
        | "9"
        | "f1"
        | "f2"
        | "f3"
        | "f4"
        | "f5"
        | "f6"
        | "f7"
        | "f8"
        | "f9"
        | "f10"
        | "f11"
        | "f12"
        | "control"
        | "alt"
        | "meta"
        | "win"
        | "cmd"
        | "option"
        | "arrowUp"
        | "arrowDown"
        | "arrowLeft"
        | "arrowRight"
        | "home"
        | "end"
        | "pageUp"
        | "pageDown"
        | "enter"
        | "space"
        | "tab"
        | "escape"
        | "backspace"
        | "insert"
        | "capsLock"
        | "numLock"
        | "scrollLock"
        | "pause"
        | "printScreen"
        | "-"
        | "/"
        | "`"
        | "\\"
        | "'"
        | "numpad0"
        | "numpad1"
        | "numpad2"
        | "numpad3"
        | "numpad4"
        | "numpad5"
        | "numpad6"
        | "numpad7"
        | "numpad8"
        | "numpad9"
        | "numpadAdd"
        | "numpadSubtract"
        | "numpadMultiply"
        | "numpadDivide"
        | "numpadDecimal"
        | "numpadEnter"
        | "numpadEqual"
        | "volumeUp"
        | "volumeDown"
        | "volumeMute"
        | "mediaPlayPause"
        | "mediaStop"
        | "mediaNextTrack"
        | "mediaPreviousTrack"
    )[]

    This is an array of keyboard keys to press. Supports cross-platform compatibility.

    outputFormat?: "base64" | "storageKey"

    Type of the URI. default is base64.

    screenshotDelay?: `${number}h` | `${number}m` | `${number}s` | `${number}ms`

    Delay after performing the action, before taking the final screenshot.

    Execution flow:

    1. Take screenshot before action
    2. Perform the action
    3. Wait for screenshotDelay (this parameter)
    4. Take screenshot after action

    Example: '500ms' means wait 500ms after the action before capturing the final screenshot.

    Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 500ms Maximum allowed: 30s