Interface ActionScreenshotParams

interface ActionScreenshotParams {
    clip?: GboxClient.V1.Boxes.ActionScreenshotParams.Clip;
    outputFormat?: "base64" | "storageKey";
    presignedExpiresIn?: string;
    scale?: number;
}

Properties

Clipping region for screenshot capture

outputFormat?: "base64" | "storageKey"

Type of the URI. default is base64.

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

scale?: number

The scale of the action to be performed. Must be greater than 0.1 and less than or equal to 1.

Notes:

Scale does not change the box's actual screen resolution.
It affects the size of the output screenshot and the coordinates/distances of actions. Coordinates and distances are scaled by this factor. Example: when scale = 1, Click({x:100, y:100}); when scale = 0.5, the equivalent position is Click({x:50, y:50}).
If not provided, uses the scale value from UI action settings; otherwise uses the passed value.