gbox-sdk
    Preparing search index...

    Interface ActionScreenshotOptions

    Action screenshot options

    interface ActionScreenshotOptions {
        delay?: string;
        outputFormat?: "base64" | "storageKey";
        phases?: ("before" | "after" | "trace")[];
        presignedExpiresIn?: string;
    }
    Index

    Properties

    delay? outputFormat? phases? presignedExpiresIn?

    Properties

    delay?: string

    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

    outputFormat?: "base64" | "storageKey"

    Type of the URI. default is base64.

    phases?: ("before" | "after" | "trace")[]

    Specify which screenshot phases to capture.

    Available options:

    • before: Screenshot before the action
    • after: Screenshot after the action
    • trace: Screenshot with operation trace

    Default captures all three phases. Can specify one or multiple in an array. If empty array is provided, no screenshots will be taken.

    presignedExpiresIn?: string

    Presigned url expires in. Only takes effect when outputFormat is storageKey.

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

    Settings

    Member Visibility

    On This Page

    Properties