gbox-sdk
    Preparing search index...

    Interface ActionSwipeAdvanced

    interface ActionSwipeAdvanced {
        duration?: string;
        end: GboxClient.V1.Boxes.ActionSwipeParams.SwipeAdvanced.End;
        includeScreenshot?: boolean;
        outputFormat?: "base64" | "storageKey";
        screenshotDelay?:
            | `${number}h`
            | `${number}m`
            | `${number}s`
            | `${number}ms`;
        start: GboxClient.V1.Boxes.ActionSwipeParams.SwipeAdvanced.Start;
    }

    Hierarchy (View Summary)

    Index

    Properties

    duration? end includeScreenshot? outputFormat? screenshotDelay? start

    Properties

    duration?: string

    Duration of the swipe

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

    end: GboxClient.V1.Boxes.ActionSwipeParams.SwipeAdvanced.End

    Swipe path

    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.

    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

    start: GboxClient.V1.Boxes.ActionSwipeParams.SwipeAdvanced.Start

    Swipe path

    Settings

    Member Visibility

    On This Page

    Properties