gbox-sdk
    Preparing search index...

    Interface Config

    Configuration for a Android box instance

    interface Config {
        deviceType?: "virtual" | "physical";
        envs?: { [key: string]: string };
        expiresIn?: string;
        keepAlive?: string;
        labels?: { [key: string]: string };
    }
    Index

    Properties

    deviceType? envs? expiresIn? keepAlive? labels?

    Properties

    deviceType?: "virtual" | "physical"

    Device type - virtual or physical Android device

    envs?: { [key: string]: string }

    Environment variables for the box. These variables will be available in all operations including command execution, code running, and other box behaviors

    expiresIn?: string

    The box will be alive for the given duration

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

    keepAlive?: string

    Keep alive duration on activity. When set to a positive value (e.g., '5m'), the box expiration time (expiresIn) will be automatically extended to ensure at least this duration remains whenever there is an box operation on this specific box. For example, when calling UI Action, FS, Browser, Command, Media, or Run Code operations with this box's boxId, the box will be kept alive. If keepAlive is '5m' and the box has 2 minutes remaining, any operation on this boxId will extend the remaining time to 5 minutes. Set to '0ms' to disable automatic keep alive extension. This helps keep frequently-used boxes alive without manual intervention.

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

    labels?: { [key: string]: string }

    Key-value pairs of labels for the box. Labels are used to add custom metadata to help identify, categorize, and manage boxes. Common use cases include project names, environments, teams, applications, or any other organizational tags that help you organize and filter your boxes.

    Settings

    Member Visibility

    On This Page

    Properties