gbox-sdk
    Preparing search index...

    Interface ScrollSimple

    interface ScrollSimple {
        direction: "up" | "down" | "left" | "right";
        distance?: number | "tiny" | "short" | "medium" | "long";
        duration?: string;
        includeScreenshot?: boolean;
        location?: string;
        options?: GboxClient.V1.Boxes.ActionCommonOptions;
        outputFormat?: "base64" | "storageKey";
        presignedExpiresIn?: string;
        screenshotDelay?: string;
    }
    Index

    Properties

    direction distance? duration? includeScreenshot? location? options? outputFormat? presignedExpiresIn? screenshotDelay?

    Properties

    direction: "up" | "down" | "left" | "right"

    Direction to scroll. The scroll will be performed from the center of the screen towards this direction. 'up' scrolls content upward (reveals content below), 'down' scrolls content downward (reveals content above), 'left' scrolls content leftward (reveals content on the right), 'right' scrolls content rightward (reveals content on the left).

    distance?: number | "tiny" | "short" | "medium" | "long"

    Distance of the scroll. Can be either a number (in pixels) or a predefined enum value (tiny, short, medium, long). If not provided, the scroll will be performed from the center of the screen to the screen edge

    duration?: string

    Duration of the scroll

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

    includeScreenshot?: boolean

    ⚠️ DEPRECATED: Use options.screenshot.phases instead. This field will be ignored when options.screenshot is provided. Whether to include screenshots in the action response. If false, the screenshot object will still be returned but with empty URIs. Default is false.

    location?: string

    Natural language description of the location where the scroll should originate. If not provided, the scroll will be performed from the center of the screen.

    options?: GboxClient.V1.Boxes.ActionCommonOptions

    Action common options

    outputFormat?: "base64" | "storageKey"

    ⚠️ DEPRECATED: Use options.screenshot.outputFormat instead. Type of the URI. default is base64. This field will be ignored when options.screenshot is provided.

    presignedExpiresIn?: string

    ⚠️ DEPRECATED: Use options.screenshot.presignedExpiresIn instead. Presigned url expires in. Only takes effect when outputFormat is storageKey. This field will be ignored when options.screenshot is provided.

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

    screenshotDelay?: string

    ⚠️ DEPRECATED: Use options.screenshot.delay instead. This field will be ignored when options.screenshot is provided.

    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

    Settings

    Member Visibility

    On This Page

    Properties