gbox-sdk
    Preparing search index...

    Interface ActionScreenshot

    interface ActionScreenshot {
        clip?: Clip;
        outputFormat?: "base64" | "storageKey";
        path?: string;
        presignedExpiresIn?: string;
        saveToAlbum?: boolean;
        scrollCapture?: ScrollCapture;
    }

    Hierarchy (View Summary)

    Index

    Properties

    clip? outputFormat? path? presignedExpiresIn? saveToAlbum? scrollCapture?

    Properties

    clip?: Clip

    Clipping region for screenshot capture

    outputFormat?: "base64" | "storageKey"

    Type of the URI. default is base64.

    path?: string

    The path to save the screenshot to. If not provided, the screenshot will not be saved to the local file system.

    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

    saveToAlbum?: boolean

    Whether to save the screenshot to the device screenshot album

    scrollCapture?: ScrollCapture

    Scroll capture parameters

    Settings

    Member Visibility

    On This Page

    Properties