Class ActionOperator

Index

Constructors

Properties

Methods

click drag getSettings longPress move pressButton pressKey resetSettings screenLayout screenRecordingStart screenRecordingStop screenRotation screenshot scroll swipe tap touch type updateSettings

Constructors

constructor

new ActionOperator(client: GboxClient, boxId: string): ActionOperator
Parameters
- client: GboxClient
- boxId: string
Returns ActionOperator
- Defined in src/wrapper/box/action.ts:233

Properties

Methods

click

click(
body: ActionBodyWithScreenshotFalse<ActionClick>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionClick>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.click({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:245
click(
body: ActionBodyWithScreenshotUndefined<ActionClick>,
): Promise<GboxClient.V1.Boxes.ActionClickResponse>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionClick>
Returns Promise<GboxClient.V1.Boxes.ActionClickResponse>
Example
```
const response = await myBox.action.click({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:246
click(
    body: ActionBodyWithScreenshotTrue<ActionClick>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionClickResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionClick>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionClickResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.click({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:247
click(
    body: ActionBodyWithScreenshotBoolean<ActionClick>,
): Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionClickResponse.Actual,
    >
    | { message: string },
>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionClick>
Returns Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionClickResponse.Actual,
    >
    | { message: string },
>
Example
```
const response = await myBox.action.click({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:250
click<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionClick, K>,
): Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionClickResponse.Actual;
        message: string;
        screenshot: {
            [P in "before"
            | "after"
            | "trace"]: NonNullable<GboxClient.V1.Boxes.ActionResult.Screenshot[P]>
        };
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionClick, K>
Returns Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionClickResponse.Actual;
        message: string;
        screenshot: {
            [P in "before"
            | "after"
            | "trace"]: NonNullable<GboxClient.V1.Boxes.ActionResult.Screenshot[P]>
        };
    },
>
Example
```
const response = await myBox.action.click({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:253
click(
    body: ActionBodyWithScreenshotObject<ActionClick>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionClickResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotObject<ActionClick>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionClickResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.click({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:261
click(
body: ActionBodyWithOptions<ActionClick>,
): Promise<GboxClient.V1.Boxes.ActionClickResponse>
Parameters
- body: ActionBodyWithOptions<ActionClick>
Returns Promise<GboxClient.V1.Boxes.ActionClickResponse>
Example
```
const response = await myBox.action.click({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:264
click(
body: ActionBodyGeneric<ActionClick>,
): Promise<GboxClient.V1.Boxes.ActionClickResponse>
Parameters
- body: ActionBodyGeneric<ActionClick>
Returns Promise<GboxClient.V1.Boxes.ActionClickResponse>
Example
```
const response = await myBox.action.click({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:265

drag

drag(
body: ActionBodyWithScreenshotFalse<ActionDrag>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionDrag>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.drag(
  {
    path: [
      { x: 100, y: 100 },
      { x: 200, y: 200 },
    ],
  }
);
```
- Defined in src/wrapper/box/action.ts:281
drag(
body: ActionBodyWithScreenshotUndefined<ActionDrag>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionDrag>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.drag(
  {
    path: [
      { x: 100, y: 100 },
      { x: 200, y: 200 },
    ],
  }
);
```
- Defined in src/wrapper/box/action.ts:282
drag(
    body: ActionBodyWithScreenshotTrue<ActionDrag>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionDragResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionDrag>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionDragResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.drag(
  {
    path: [
      { x: 100, y: 100 },
      { x: 200, y: 200 },
    ],
  }
);
```
- Defined in src/wrapper/box/action.ts:283
drag(
    body: ActionBodyWithScreenshotBoolean<ActionDrag>,
): Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionDragResponse.Actual,
    >
    | { message: string },
>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionDrag>
Returns Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionDragResponse.Actual,
    >
    | { message: string },
>
Example
```
const response = await myBox.action.drag(
  {
    path: [
      { x: 100, y: 100 },
      { x: 200, y: 200 },
    ],
  }
);
```
- Defined in src/wrapper/box/action.ts:286
drag<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionDrag, K>,
): Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionDragResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionDrag, K>
Returns Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionDragResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.drag(
  {
    path: [
      { x: 100, y: 100 },
      { x: 200, y: 200 },
    ],
  }
);
```
- Defined in src/wrapper/box/action.ts:289
drag(
    body: ActionBodyWithScreenshotObject<ActionDrag>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionDragResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotObject<ActionDrag>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionDragResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.drag(
  {
    path: [
      { x: 100, y: 100 },
      { x: 200, y: 200 },
    ],
  }
);
```
- Defined in src/wrapper/box/action.ts:297
drag(
body: ActionBodyWithOptions<ActionDrag>,
): Promise<GboxClient.V1.Boxes.ActionDragResponse>
Parameters
- body: ActionBodyWithOptions<ActionDrag>
Returns Promise<GboxClient.V1.Boxes.ActionDragResponse>
Example
```
const response = await myBox.action.drag(
  {
    path: [
      { x: 100, y: 100 },
      { x: 200, y: 200 },
    ],
  }
);
```
- Defined in src/wrapper/box/action.ts:300
drag(
body: ActionBodyGeneric<ActionDrag>,
): Promise<GboxClient.V1.Boxes.ActionDragResponse>
Parameters
- body: ActionBodyGeneric<ActionDrag>
Returns Promise<GboxClient.V1.Boxes.ActionDragResponse>
Example
```
const response = await myBox.action.drag(
  {
    path: [
      { x: 100, y: 100 },
      { x: 200, y: 200 },
    ],
  }
);
```
- Defined in src/wrapper/box/action.ts:301

getSettings

getSettings(): Promise<GboxClient.V1.Boxes.ActionSettingsResponse>
Returns Promise<GboxClient.V1.Boxes.ActionSettingsResponse>
Example
```
const response = await myBox.action.getSetting();
```
- Defined in src/wrapper/box/action.ts:630

longPress

longPress(
body: ActionBodyWithScreenshotFalse<ActionLongPress>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionLongPress>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.longPress({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:445
longPress(
body: ActionBodyWithScreenshotUndefined<ActionLongPress>,
): Promise<GboxClient.V1.Boxes.ActionLongPressResponse>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionLongPress>
Returns Promise<GboxClient.V1.Boxes.ActionLongPressResponse>
Example
```
const response = await myBox.action.longPress({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:446
longPress(
    body: ActionBodyWithScreenshotTrue<ActionLongPress>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionLongPress>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.longPress({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:447
longPress(
    body: ActionBodyWithScreenshotBoolean<ActionLongPress>,
): Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
    >
    | { message: string },
>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionLongPress>
Returns Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
    >
    | { message: string },
>
Example
```
const response = await myBox.action.longPress({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:450
longPress<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionLongPress, K>,
): Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionLongPressResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionLongPress, K>
Returns Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionLongPressResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.longPress({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:453
longPress(
    body: ActionBodyWithScreenshotObject<ActionLongPress>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotObject<ActionLongPress>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.longPress({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:461
longPress(
body: ActionBodyWithOptions<ActionLongPress>,
): Promise<GboxClient.V1.Boxes.ActionLongPressResponse>
Parameters
- body: ActionBodyWithOptions<ActionLongPress>
Returns Promise<GboxClient.V1.Boxes.ActionLongPressResponse>
Example
```
const response = await myBox.action.longPress({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:464
longPress(
body: ActionBodyGeneric<ActionLongPress>,
): Promise<GboxClient.V1.Boxes.ActionLongPressResponse>
Parameters
- body: ActionBodyGeneric<ActionLongPress>
Returns Promise<GboxClient.V1.Boxes.ActionLongPressResponse>
Example
```
const response = await myBox.action.longPress({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:465

move

move(
body: ActionBodyWithScreenshotFalse<ActionMove>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionMove>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.move({ x: 200, y: 300 });
```
- Defined in src/wrapper/box/action.ts:392
move(
body: ActionBodyWithScreenshotUndefined<ActionMove>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionMove>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.move({ x: 200, y: 300 });
```
- Defined in src/wrapper/box/action.ts:393
move(
body: ActionBodyWithScreenshotTrue<ActionMove>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionMove>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.move({ x: 200, y: 300 });
```
- Defined in src/wrapper/box/action.ts:394
move(
body: ActionBodyWithScreenshotBoolean<ActionMove>,
): Promise<ActionResultWithScreenshot<{}> | { message: string }>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionMove>
Returns Promise<ActionResultWithScreenshot<{}> | { message: string }>
Example
```
const response = await myBox.action.move({ x: 200, y: 300 });
```
- Defined in src/wrapper/box/action.ts:395
move<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionMove, K>,
): Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionMove, K>
Returns Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.move({ x: 200, y: 300 });
```
- Defined in src/wrapper/box/action.ts:398
move(
body: ActionBodyWithScreenshotObject<ActionMove>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotObject<ActionMove>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.move({ x: 200, y: 300 });
```
- Defined in src/wrapper/box/action.ts:405
move(
body: ActionBodyWithOptions<ActionMove>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithOptions<ActionMove>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.move({ x: 200, y: 300 });
```
- Defined in src/wrapper/box/action.ts:406
move(
body: ActionBodyGeneric<ActionMove>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyGeneric<ActionMove>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.move({ x: 200, y: 300 });
```
- Defined in src/wrapper/box/action.ts:407

pressButton

pressButton(
body: ActionBodyWithScreenshotFalse<ActionPressButton>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionPressButton>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.pressButton({ buttons: ['power']});
```
- Defined in src/wrapper/box/action.ts:365
pressButton(
body: ActionBodyWithScreenshotUndefined<ActionPressButton>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionPressButton>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.pressButton({ buttons: ['power']});
```
- Defined in src/wrapper/box/action.ts:366
pressButton(
body: ActionBodyWithScreenshotTrue<ActionPressButton>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionPressButton>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.pressButton({ buttons: ['power']});
```
- Defined in src/wrapper/box/action.ts:367
pressButton(
body: ActionBodyWithScreenshotBoolean<ActionPressButton>,
): Promise<ActionResultWithScreenshot<{}> | { message: string }>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionPressButton>
Returns Promise<ActionResultWithScreenshot<{}> | { message: string }>
Example
```
const response = await myBox.action.pressButton({ buttons: ['power']});
```
- Defined in src/wrapper/box/action.ts:370
pressButton<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionPressButton, K>,
): Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionPressButton, K>
Returns Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.pressButton({ buttons: ['power']});
```
- Defined in src/wrapper/box/action.ts:373
pressButton(
body: ActionBodyWithScreenshotObject<ActionPressButton>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotObject<ActionPressButton>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.pressButton({ buttons: ['power']});
```
- Defined in src/wrapper/box/action.ts:380
pressButton(
body: ActionBodyWithOptions<ActionPressButton>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithOptions<ActionPressButton>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.pressButton({ buttons: ['power']});
```
- Defined in src/wrapper/box/action.ts:383
pressButton(
body: ActionBodyGeneric<ActionPressButton>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyGeneric<ActionPressButton>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.pressButton({ buttons: ['power']});
```
- Defined in src/wrapper/box/action.ts:384

pressKey

pressKey(
body: ActionBodyWithScreenshotFalse<ActionPressKey>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionPressKey>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.pressKey({ keys: ['enter'] });
```
- Defined in src/wrapper/box/action.ts:339
pressKey(
body: ActionBodyWithScreenshotUndefined<ActionPressKey>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionPressKey>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.pressKey({ keys: ['enter'] });
```
- Defined in src/wrapper/box/action.ts:340
pressKey(
body: ActionBodyWithScreenshotTrue<ActionPressKey>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionPressKey>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.pressKey({ keys: ['enter'] });
```
- Defined in src/wrapper/box/action.ts:341
pressKey(
body: ActionBodyWithScreenshotBoolean<ActionPressKey>,
): Promise<ActionResultWithScreenshot<{}> | { message: string }>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionPressKey>
Returns Promise<ActionResultWithScreenshot<{}> | { message: string }>
Example
```
const response = await myBox.action.pressKey({ keys: ['enter'] });
```
- Defined in src/wrapper/box/action.ts:342
pressKey<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionPressKey, K>,
): Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionPressKey, K>
Returns Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.pressKey({ keys: ['enter'] });
```
- Defined in src/wrapper/box/action.ts:345
pressKey(
body: ActionBodyWithScreenshotObject<ActionPressKey>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotObject<ActionPressKey>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.pressKey({ keys: ['enter'] });
```
- Defined in src/wrapper/box/action.ts:352
pressKey(
body: ActionBodyWithOptions<ActionPressKey>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithOptions<ActionPressKey>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.pressKey({ keys: ['enter'] });
```
- Defined in src/wrapper/box/action.ts:355
pressKey(
body: ActionBodyGeneric<ActionPressKey>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyGeneric<ActionPressKey>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.pressKey({ keys: ['enter'] });
```
- Defined in src/wrapper/box/action.ts:356

resetSettings

resetSettings(): Promise<GboxClient.V1.Boxes.ActionSettingsResetResponse>
Returns Promise<GboxClient.V1.Boxes.ActionSettingsResetResponse>
Example
```
const response = await myBox.action.resetSetting();
```
- Defined in src/wrapper/box/action.ts:646

screenLayout

screenLayout(): Promise<GboxClient.V1.Boxes.ActionScreenLayoutResponse>
Returns Promise<GboxClient.V1.Boxes.ActionScreenLayoutResponse>
Example
```
const response = await myBox.action.screenLayout();
```
- Defined in src/wrapper/box/action.ts:604

screenRecordingStart

screenRecordingStart(): Promise<void>
Returns Promise<void>
Deprecated
please use ActionOperator.screenRecordingStart instead.
Example
```
const response = await myBox.action.screenRecordingStart();
```
- Defined in src/wrapper/box/action.ts:613

screenRecordingStop

screenRecordingStop(): Promise<GboxClient.V1.Boxes.ActionRecordingStopResponse>
Returns Promise<GboxClient.V1.Boxes.ActionRecordingStopResponse>
Deprecated
please use ActionOperator.screenRecordingStart instead.
Example
```
const response = await myBox.action.screenRecordingStop();
```
- Defined in src/wrapper/box/action.ts:622

screenRotation

screenRotation(
body: ActionBodyWithScreenshotFalse<ActionScreenRotation>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionScreenRotation>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.screenRotation({ orientation: 'landscapeLeft' });
```
- Defined in src/wrapper/box/action.ts:557
screenRotation(
body: ActionBodyWithScreenshotUndefined<ActionScreenRotation>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionScreenRotation>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.screenRotation({ orientation: 'landscapeLeft' });
```
- Defined in src/wrapper/box/action.ts:560
screenRotation(
body: ActionBodyWithScreenshotTrue<ActionScreenRotation>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionScreenRotation>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.screenRotation({ orientation: 'landscapeLeft' });
```
- Defined in src/wrapper/box/action.ts:561
screenRotation(
body: ActionBodyWithScreenshotBoolean<ActionScreenRotation>,
): Promise<ActionResultWithScreenshot<{}> | { message: string }>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionScreenRotation>
Returns Promise<ActionResultWithScreenshot<{}> | { message: string }>
Example
```
const response = await myBox.action.screenRotation({ orientation: 'landscapeLeft' });
```
- Defined in src/wrapper/box/action.ts:564
screenRotation<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionScreenRotation, K>,
): Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionScreenRotation, K>
Returns Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.screenRotation({ orientation: 'landscapeLeft' });
```
- Defined in src/wrapper/box/action.ts:567
screenRotation(
body: ActionBodyWithScreenshotObject<ActionScreenRotation>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotObject<ActionScreenRotation>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.screenRotation({ orientation: 'landscapeLeft' });
```
- Defined in src/wrapper/box/action.ts:574
screenRotation(
body: ActionBodyWithOptions<ActionScreenRotation>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithOptions<ActionScreenRotation>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.screenRotation({ orientation: 'landscapeLeft' });
```
- Defined in src/wrapper/box/action.ts:577
screenRotation(
body: ActionBodyGeneric<ActionScreenRotation>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyGeneric<ActionScreenRotation>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.screenRotation({ orientation: 'landscapeLeft' });
```
- Defined in src/wrapper/box/action.ts:578

screenshot

screenshot(
body?: ActionScreenshot,
): Promise<GboxClient.V1.Boxes.ActionScreenshotResponse>
Parameters
- Optionalbody: ActionScreenshot
Returns Promise<GboxClient.V1.Boxes.ActionScreenshotResponse>
Example
```
const response = await myBox.action.screenshot();
or
const response = await myBox.action.screenshot({ outputFormat: 'base64' });
```
- Defined in src/wrapper/box/action.ts:589

scroll

scroll(
body: ActionBodyWithScreenshotFalse<ActionScroll>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionScroll>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.scroll({ direction: 'up' });
const response = await myBox.action.scroll({ scrollX: 0, scrollY: 100, x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:475
scroll(
body: ActionBodyWithScreenshotUndefined<ActionScroll>,
): Promise<GboxClient.V1.Boxes.ActionScrollResponse>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionScroll>
Returns Promise<GboxClient.V1.Boxes.ActionScrollResponse>
Example
```
const response = await myBox.action.scroll({ direction: 'up' });
const response = await myBox.action.scroll({ scrollX: 0, scrollY: 100, x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:476
scroll(
    body: ActionBodyWithScreenshotTrue<ActionScroll>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionScrollResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionScroll>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionScrollResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.scroll({ direction: 'up' });
const response = await myBox.action.scroll({ scrollX: 0, scrollY: 100, x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:477
scroll(
    body: ActionBodyWithScreenshotBoolean<ActionScroll>,
): Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionScrollResponse.Actual,
    >
    | { message: string },
>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionScroll>
Returns Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionScrollResponse.Actual,
    >
    | { message: string },
>
Example
```
const response = await myBox.action.scroll({ direction: 'up' });
const response = await myBox.action.scroll({ scrollX: 0, scrollY: 100, x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:480
scroll<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionScroll, K>,
): Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionScrollResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionScroll, K>
Returns Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionScrollResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.scroll({ direction: 'up' });
const response = await myBox.action.scroll({ scrollX: 0, scrollY: 100, x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:483
scroll(
    body: ActionBodyWithScreenshotObject<ActionScroll>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionScrollResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotObject<ActionScroll>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionScrollResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.scroll({ direction: 'up' });
const response = await myBox.action.scroll({ scrollX: 0, scrollY: 100, x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:491
scroll(
body: ActionBodyWithOptions<ActionScroll>,
): Promise<GboxClient.V1.Boxes.ActionScrollResponse>
Parameters
- body: ActionBodyWithOptions<ActionScroll>
Returns Promise<GboxClient.V1.Boxes.ActionScrollResponse>
Example
```
const response = await myBox.action.scroll({ direction: 'up' });
const response = await myBox.action.scroll({ scrollX: 0, scrollY: 100, x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:494
scroll(
body: ActionBodyGeneric<ActionScroll>,
): Promise<GboxClient.V1.Boxes.ActionScrollResponse>
Parameters
- body: ActionBodyGeneric<ActionScroll>
Returns Promise<GboxClient.V1.Boxes.ActionScrollResponse>
Example
```
const response = await myBox.action.scroll({ direction: 'up' });
const response = await myBox.action.scroll({ scrollX: 0, scrollY: 100, x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:495

swipe

swipe(
body: ActionBodyWithScreenshotFalse<ActionSwipe>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionSwipe>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.swipe({ direction: 'up' });
```
- Defined in src/wrapper/box/action.ts:310
swipe(
body: ActionBodyWithScreenshotUndefined<ActionSwipe>,
): Promise<GboxClient.V1.Boxes.ActionSwipeResponse>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionSwipe>
Returns Promise<GboxClient.V1.Boxes.ActionSwipeResponse>
Example
```
const response = await myBox.action.swipe({ direction: 'up' });
```
- Defined in src/wrapper/box/action.ts:311
swipe(
    body: ActionBodyWithScreenshotTrue<ActionSwipe>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionSwipeResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionSwipe>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionSwipeResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.swipe({ direction: 'up' });
```
- Defined in src/wrapper/box/action.ts:312
swipe(
    body: ActionBodyWithScreenshotBoolean<ActionSwipe>,
): Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionSwipeResponse.Actual,
    >
    | { message: string },
>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionSwipe>
Returns Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionSwipeResponse.Actual,
    >
    | { message: string },
>
Example
```
const response = await myBox.action.swipe({ direction: 'up' });
```
- Defined in src/wrapper/box/action.ts:315
swipe<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionSwipe, K>,
): Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionSwipeResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionSwipe, K>
Returns Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionSwipeResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.swipe({ direction: 'up' });
```
- Defined in src/wrapper/box/action.ts:318
swipe(
    body: ActionBodyWithScreenshotObject<ActionSwipe>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionSwipeResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotObject<ActionSwipe>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionSwipeResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.swipe({ direction: 'up' });
```
- Defined in src/wrapper/box/action.ts:326
swipe(
body: ActionBodyWithOptions<ActionSwipe>,
): Promise<GboxClient.V1.Boxes.ActionSwipeResponse>
Parameters
- body: ActionBodyWithOptions<ActionSwipe>
Returns Promise<GboxClient.V1.Boxes.ActionSwipeResponse>
Example
```
const response = await myBox.action.swipe({ direction: 'up' });
```
- Defined in src/wrapper/box/action.ts:329
swipe(
body: ActionBodyGeneric<ActionSwipe>,
): Promise<GboxClient.V1.Boxes.ActionSwipeResponse>
Parameters
- body: ActionBodyGeneric<ActionSwipe>
Returns Promise<GboxClient.V1.Boxes.ActionSwipeResponse>
Example
```
const response = await myBox.action.swipe({ direction: 'up' });
```
- Defined in src/wrapper/box/action.ts:330

tap

tap(
body: ActionBodyWithScreenshotFalse<ActionTap>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionTap>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.tap({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:416
tap(
body: ActionBodyWithScreenshotUndefined<ActionTap>,
): Promise<GboxClient.V1.Boxes.ActionTapResponse>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionTap>
Returns Promise<GboxClient.V1.Boxes.ActionTapResponse>
Example
```
const response = await myBox.action.tap({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:417
tap(
body: ActionBodyWithScreenshotTrue<ActionTap>,
): Promise<
ActionResultWithScreenshot<GboxClient.V1.Boxes.ActionTapResponse.Actual>,
>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionTap>
Returns Promise<
ActionResultWithScreenshot<GboxClient.V1.Boxes.ActionTapResponse.Actual>,
>
Example
```
const response = await myBox.action.tap({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:418
tap(
    body: ActionBodyWithScreenshotBoolean<ActionTap>,
): Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionTapResponse.Actual,
    >
    | { message: string },
>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionTap>
Returns Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionTapResponse.Actual,
    >
    | { message: string },
>
Example
```
const response = await myBox.action.tap({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:421
tap<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionTap, K>,
): Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionTapResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionTap, K>
Returns Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionTapResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.tap({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:424
tap(
body: ActionBodyWithScreenshotObject<ActionTap>,
): Promise<
ActionResultWithScreenshot<GboxClient.V1.Boxes.ActionTapResponse.Actual>,
>
Parameters
- body: ActionBodyWithScreenshotObject<ActionTap>
Returns Promise<
ActionResultWithScreenshot<GboxClient.V1.Boxes.ActionTapResponse.Actual>,
>
Example
```
const response = await myBox.action.tap({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:432
tap(
body: ActionBodyWithOptions<ActionTap>,
): Promise<GboxClient.V1.Boxes.ActionTapResponse>
Parameters
- body: ActionBodyWithOptions<ActionTap>
Returns Promise<GboxClient.V1.Boxes.ActionTapResponse>
Example
```
const response = await myBox.action.tap({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:435
tap(
body: ActionBodyGeneric<ActionTap>,
): Promise<GboxClient.V1.Boxes.ActionTapResponse>
Parameters
- body: ActionBodyGeneric<ActionTap>
Returns Promise<GboxClient.V1.Boxes.ActionTapResponse>
Example
```
const response = await myBox.action.tap({ x: 100, y: 100 });
```
- Defined in src/wrapper/box/action.ts:436

touch

touch(
body: ActionBodyWithScreenshotFalse<ActionTouch>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionTouch>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.touch({ points: [{ start: { x: 0, y: 0 } }] });
```
- Defined in src/wrapper/box/action.ts:504
touch(
body: ActionBodyWithScreenshotUndefined<ActionTouch>,
): Promise<GboxClient.V1.Boxes.ActionTouchResponse>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionTouch>
Returns Promise<GboxClient.V1.Boxes.ActionTouchResponse>
Example
```
const response = await myBox.action.touch({ points: [{ start: { x: 0, y: 0 } }] });
```
- Defined in src/wrapper/box/action.ts:505
touch(
    body: ActionBodyWithScreenshotTrue<ActionTouch>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionTouchResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionTouch>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionTouchResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.touch({ points: [{ start: { x: 0, y: 0 } }] });
```
- Defined in src/wrapper/box/action.ts:506
touch(
    body: ActionBodyWithScreenshotBoolean<ActionTouch>,
): Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionTouchResponse.Actual,
    >
    | { message: string },
>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionTouch>
Returns Promise<
    | ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionTouchResponse.Actual,
    >
    | { message: string },
>
Example
```
const response = await myBox.action.touch({ points: [{ start: { x: 0, y: 0 } }] });
```
- Defined in src/wrapper/box/action.ts:509
touch<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionTouch, K>,
): Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionTouchResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionTouch, K>
Returns Promise<
    {
        actionId: string;
        actual: GboxClient.V1.Boxes.ActionTouchResponse.Actual;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.touch({ points: [{ start: { x: 0, y: 0 } }] });
```
- Defined in src/wrapper/box/action.ts:512
touch(
    body: ActionBodyWithScreenshotObject<ActionTouch>,
): Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionTouchResponse.Actual,
    >,
>
Parameters
- body: ActionBodyWithScreenshotObject<ActionTouch>
Returns Promise<
    ActionResultWithScreenshot<
        GboxClient.V1.Boxes.ActionTouchResponse.Actual,
    >,
>
Example
```
const response = await myBox.action.touch({ points: [{ start: { x: 0, y: 0 } }] });
```
- Defined in src/wrapper/box/action.ts:520
touch(
body: ActionBodyWithOptions<ActionTouch>,
): Promise<GboxClient.V1.Boxes.ActionTouchResponse>
Parameters
- body: ActionBodyWithOptions<ActionTouch>
Returns Promise<GboxClient.V1.Boxes.ActionTouchResponse>
Example
```
const response = await myBox.action.touch({ points: [{ start: { x: 0, y: 0 } }] });
```
- Defined in src/wrapper/box/action.ts:523
touch(
body: ActionBodyGeneric<ActionTouch>,
): Promise<GboxClient.V1.Boxes.ActionTouchResponse>
Parameters
- body: ActionBodyGeneric<ActionTouch>
Returns Promise<GboxClient.V1.Boxes.ActionTouchResponse>
Example
```
const response = await myBox.action.touch({ points: [{ start: { x: 0, y: 0 } }] });
```
- Defined in src/wrapper/box/action.ts:524

type

type(
body: ActionBodyWithScreenshotFalse<ActionType>,
): Promise<{ message: string }>
Parameters
- body: ActionBodyWithScreenshotFalse<ActionType>
Returns Promise<{ message: string }>
Example
```
const response = await myBox.action.type({ text: 'Hello, World!' });
```
- Defined in src/wrapper/box/action.ts:533
type(
body: ActionBodyWithScreenshotUndefined<ActionType>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithScreenshotUndefined<ActionType>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.type({ text: 'Hello, World!' });
```
- Defined in src/wrapper/box/action.ts:534
type(
body: ActionBodyWithScreenshotTrue<ActionType>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotTrue<ActionType>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.type({ text: 'Hello, World!' });
```
- Defined in src/wrapper/box/action.ts:535
type(
body: ActionBodyWithScreenshotBoolean<ActionType>,
): Promise<ActionResultWithScreenshot<{}> | { message: string }>
Parameters
- body: ActionBodyWithScreenshotBoolean<ActionType>
Returns Promise<ActionResultWithScreenshot<{}> | { message: string }>
Example
```
const response = await myBox.action.type({ text: 'Hello, World!' });
```
- Defined in src/wrapper/box/action.ts:536
type<K extends readonly ("before" | "after" | "trace")[]>(
    body: ActionBodyWithScreenshotPhases<ActionType, K>,
): Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Type Parameters
- K extends readonly ("before" | "after" | "trace")[]
Parameters
- body: ActionBodyWithScreenshotPhases<ActionType, K>
Returns Promise<
    {
        actionId: string;
        message: string;
        screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
    },
>
Example
```
const response = await myBox.action.type({ text: 'Hello, World!' });
```
- Defined in src/wrapper/box/action.ts:539
type(
body: ActionBodyWithScreenshotObject<ActionType>,
): Promise<ActionResultWithScreenshot<{}>>
Parameters
- body: ActionBodyWithScreenshotObject<ActionType>
Returns Promise<ActionResultWithScreenshot<{}>>
Example
```
const response = await myBox.action.type({ text: 'Hello, World!' });
```
- Defined in src/wrapper/box/action.ts:546
type(
body: ActionBodyWithOptions<ActionType>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyWithOptions<ActionType>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.type({ text: 'Hello, World!' });
```
- Defined in src/wrapper/box/action.ts:547
type(
body: ActionBodyGeneric<ActionType>,
): Promise<GboxClient.V1.Boxes.ActionResult>
Parameters
- body: ActionBodyGeneric<ActionType>
Returns Promise<GboxClient.V1.Boxes.ActionResult>
Example
```
const response = await myBox.action.type({ text: 'Hello, World!' });
```
- Defined in src/wrapper/box/action.ts:548

updateSettings

updateSettings(
body: GboxClient.V1.Boxes.ActionSettingsUpdateParams,
): Promise<GboxClient.V1.Boxes.ActionSettingsUpdateResponse>
Parameters
- body: GboxClient.V1.Boxes.ActionSettingsUpdateParams
Returns Promise<GboxClient.V1.Boxes.ActionSettingsUpdateResponse>
Example
```
const response = await myBox.action.updateSetting({ scale: 0.5 });
```
- Defined in src/wrapper/box/action.ts:638

Class ActionOperator

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActionOperator

Properties

clipboard

elements

recording

Methods

click

Parameters

Returns Promise<{ message: string }>

Example

Parameters

Returns Promise<GboxClient.V1.Boxes.ActionClickResponse>

Example

Parameters

Returns Promise< ActionResultWithScreenshot< GboxClient.V1.Boxes.ActionClickResponse.Actual, >,>

Example

Parameters

Returns Promise< | ActionResultWithScreenshot< GboxClient.V1.Boxes.ActionClickResponse.Actual, > | { message: string },>

Example

Type Parameters

Parameters

Returns Promise< { actionId: string; actual: GboxClient.V1.Boxes.ActionClickResponse.Actual; message: string; screenshot: { [P in "before" | "after" | "trace"]: NonNullable<GboxClient.V1.Boxes.ActionResult.Screenshot[P]> }; },>

Example

Parameters

Returns Promise< ActionResultWithScreenshot< GboxClient.V1.Boxes.ActionClickResponse.Actual, >,>

Example

Parameters

Returns Promise<GboxClient.V1.Boxes.ActionClickResponse>

Example

Parameters

Returns Promise<GboxClient.V1.Boxes.ActionClickResponse>

Example

drag

Parameters

Returns Promise<{ message: string }>

Example

Parameters

Returns Promise<GboxClient.V1.Boxes.ActionResult>

Example

Parameters

Returns Promise< ActionResultWithScreenshot< GboxClient.V1.Boxes.ActionDragResponse.Actual, >,>

Example

Parameters

Returns Promise< | ActionResultWithScreenshot< GboxClient.V1.Boxes.ActionDragResponse.Actual, > | { message: string },>

Example

Type Parameters

Parameters

Returns Promise< { actionId: string; actual: GboxClient.V1.Boxes.ActionDragResponse.Actual; message: string; screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>; },>

Example

Parameters

Returns Promise< ActionResultWithScreenshot< GboxClient.V1.Boxes.ActionDragResponse.Actual, >,>

Example

Parameters

Returns Promise<GboxClient.V1.Boxes.ActionDragResponse>

Example

Parameters

Returns Promise<GboxClient.V1.Boxes.ActionDragResponse>

Example

getSettings

Returns Promise<GboxClient.V1.Boxes.ActionSettingsResponse>

Example

longPress

Parameters

Returns Promise<{ message: string }>

Example

Parameters

Returns Promise<GboxClient.V1.Boxes.ActionLongPressResponse>

Example

Parameters

Returns Promise< ActionResultWithScreenshot< GboxClient.V1.Boxes.ActionLongPressResponse.Actual, >,>

Example

Parameters

Returns Promise<
ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionClickResponse.Actual,
>,
>

Returns Promise<
| ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionClickResponse.Actual,
>
| { message: string },
>

Returns Promise<
{
actionId: string;
actual: GboxClient.V1.Boxes.ActionClickResponse.Actual;
message: string;
screenshot: {
[P in "before"
| "after"
| "trace"]: NonNullable<GboxClient.V1.Boxes.ActionResult.Screenshot[P]>
};
},
>

Returns Promise<
ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionClickResponse.Actual,
>,
>

Returns Promise<
ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionDragResponse.Actual,
>,
>

Returns Promise<
| ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionDragResponse.Actual,
>
| { message: string },
>

Returns Promise<
{
actionId: string;
actual: GboxClient.V1.Boxes.ActionDragResponse.Actual;
message: string;
screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
},
>

Returns Promise<
ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionDragResponse.Actual,
>,
>

Returns Promise<
ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
>,
>

Returns Promise<
| ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
>
| { message: string },
>

Returns Promise<
{
actionId: string;
actual: GboxClient.V1.Boxes.ActionLongPressResponse.Actual;
message: string;
screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
},
>

Returns Promise<
ActionResultWithScreenshot<
GboxClient.V1.Boxes.ActionLongPressResponse.Actual,
>,
>

Returns Promise<
{
actionId: string;
message: string;
screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
},
>

Returns Promise<
{
actionId: string;
message: string;
screenshot: ScreenshotPickOf<GboxClient.V1.Boxes.ActionResult, K[number]>;
},
>