Class Actions

Hierarchy

APIResource
- Actions

Index

Constructors

constructor

new Actions(client: GboxClient): GboxClient.V1.Boxes.Actions
Parameters
- client: GboxClient
Returns GboxClient.V1.Boxes.Actions
Inherited from APIResource.constructor
- Defined in src/core/resource.ts:8

Properties

`Protected`_client

_client: GboxClient

Methods

ai

ai(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionAIParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionAIResponse>
Use natural language instructions to perform UI operations on the box. You can describe what you want to do in plain language (e.g., 'click the login button', 'scroll down to find settings', 'input my email address'), and the AI will automatically convert your instruction into the appropriate UI action and execute it on the box.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionAIParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionAIResponse>
Example
```
const response = await client.v1.boxes.actions.ai(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { instruction: 'click the login button' },
);
```
- Defined in src/resources/v1/boxes/actions.ts:24

click

click(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionClickParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionClickResponse>
Click
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionClickParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionClickResponse>
Example
```
const response = await client.v1.boxes.actions.click(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { x: 100, y: 100 },
);
```
- Defined in src/resources/v1/boxes/actions.ts:39

drag

drag(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionDragParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionDragResponse>
Drag
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionDragParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionDragResponse>
Example
```
const response = await client.v1.boxes.actions.drag(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { end: { x: 200, y: 200 }, start: { x: 100, y: 100 } },
);
```
- Defined in src/resources/v1/boxes/actions.ts:54

extract

extract(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionExtractParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionExtractResponse>
Extract data from the UI interface using a JSON schema.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionExtractParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionExtractResponse>
Example
```
const response = await client.v1.boxes.actions.extract(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  {
    instruction:
      'Extract the email address from the UI interface',
  },
);
```
- Defined in src/resources/v1/boxes/actions.ts:72

move

move(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionMoveParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionMoveResponse>
Move to position
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionMoveParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionMoveResponse>
Example
```
const response = await client.v1.boxes.actions.move(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { x: 200, y: 300 },
);
```
- Defined in src/resources/v1/boxes/actions.ts:91

pressButton

pressButton(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionPressButtonParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionPressButtonResponse>
Press button on the device. like power button, volume up button, volume down button, etc.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionPressButtonParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionPressButtonResponse>
Example
```
const response = await client.v1.boxes.actions.pressButton(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { buttons: ['power'] },
);
```
- Defined in src/resources/v1/boxes/actions.ts:107

pressKey

pressKey(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionPressKeyParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionPressKeyResponse>
Simulates pressing a specific key by triggering the complete keyboard key event chain (keydown, keypress, keyup). Use this to activate keyboard key event listeners such as shortcuts or form submissions.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionPressKeyParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionPressKeyResponse>
Example
```
const response = await client.v1.boxes.actions.pressKey(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { keys: ['enter'] },
);
```
- Defined in src/resources/v1/boxes/actions.ts:128

screenLayout

screenLayout(
boxID: string,
options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionScreenLayoutResponse>
Get the current structured screen layout information. This endpoint returns detailed structural information about the UI elements currently displayed on the screen, which can be used for UI automation, element analysis, and accessibility purposes. The format varies by box type: Android boxes return XML format with detailed UI hierarchy information including element bounds, text content, resource IDs, and properties, while other box types may return different structured formats.
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionScreenLayoutResponse>
Example
```
const response = await client.v1.boxes.actions.screenLayout(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/actions.ts:152

screenRotation

screenRotation(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionScreenRotationParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionScreenRotationResponse>
Rotate screen
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionScreenRotationParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionScreenRotationResponse>
Example
```
const response =
  await client.v1.boxes.actions.screenRotation(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    { angle: 90, direction: 'clockwise' },
  );
```
- Defined in src/resources/v1/boxes/actions.ts:168

screenshot

screenshot(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionScreenshotParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionScreenshotResponse>
Take screenshot
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionScreenshotParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionScreenshotResponse>
Example
```
const response = await client.v1.boxes.actions.screenshot(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/actions.ts:186

scroll

scroll(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionScrollParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionScrollResponse>
Scroll
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionScrollParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionScrollResponse>
Example
```
const response = await client.v1.boxes.actions.scroll(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { scrollX: 0, scrollY: 100, x: 100, y: 100 },
);
```
- Defined in src/resources/v1/boxes/actions.ts:205

swipe

swipe(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionSwipeParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionSwipeResponse>
Performs a swipe in the specified direction
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionSwipeParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionSwipeResponse>
Example
```
const response = await client.v1.boxes.actions.swipe(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { direction: 'up' },
);
```
- Defined in src/resources/v1/boxes/actions.ts:224

touch

touch(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionTouchParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionTouchResponse>

Touch

Parameters

boxID: string
body: GboxClient.V1.Boxes.ActionTouchParams
Optionaloptions: RequestOptions

Returns APIPromise<GboxClient.V1.Boxes.ActionTouchResponse>

Example

const response = await client.v1.boxes.actions.touch(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  {
    points: [
      {
        start: { x: 100, y: 150 },
        actions: [
          {
            type: 'move',
            x: 400,
            y: 300,
            duration: '200ms',
          },
        ],
      },
    ],
  },
);

type

type(
    boxID: string,
    body: GboxClient.V1.Boxes.ActionTypeParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ActionTypeResponse>
Directly inputs text content without triggering physical key events (keydown, etc.), ideal for quickly filling large amounts of text when intermediate input events aren't needed.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ActionTypeParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ActionTypeResponse>
Example
```
const response = await client.v1.boxes.actions.type(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { text: 'Hello World' },
);
```
- Defined in src/resources/v1/boxes/actions.ts:270

Class Actions

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GboxClient.V1.Boxes.Actions

Properties

Protected_client

Methods

ai

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionAIResponse>

Example

click

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionClickResponse>

Example

drag

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionDragResponse>

Example

extract

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionExtractResponse>

Example

move

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionMoveResponse>

Example

pressButton

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionPressButtonResponse>

Example

pressKey

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionPressKeyResponse>

Example

screenLayout

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionScreenLayoutResponse>

Example

screenRotation

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionScreenRotationResponse>

Example

screenshot

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionScreenshotResponse>

Example

scroll

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionScrollResponse>

Example

swipe

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionSwipeResponse>

Example

touch

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionTouchResponse>

Example

type

Parameters

Returns APIPromise<GboxClient.V1.Boxes.ActionTypeResponse>

Example

Settings

On This Page

`Protected`_client