Class Android

Hierarchy

APIResource
- Android

Index

Constructors

Properties

Methods

appiumURL backup backupAll close closeAll get getApp getConnectAddress install listActivities listApp listPkg listPkgSimple open restart restore uninstall

Constructors

constructor

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

Properties

`Protected`_client

_client: GboxClient

Methods

appiumURL

appiumURL(
    boxID: string,
    body?: GboxClient.V1.Boxes.AndroidAppiumURLParams | null | undefined,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidAppiumURLResponse>
Generate a pre-signed proxy URL for Appium server of a running Android box.
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.AndroidAppiumURLParams | null | undefined = {}
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidAppiumURLResponse>
Example
```
const response = await client.v1.boxes.android.appiumURL(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/android.ts:22

backup

backup(
    packageName: string,
    params: GboxClient.V1.Boxes.AndroidBackupParams,
    options?: RequestOptions,
): APIPromise<Response>
Backup
Parameters
- packageName: string
- params: GboxClient.V1.Boxes.AndroidBackupParams
- Optionaloptions: RequestOptions
Returns APIPromise<Response>
Example
```
const response = await client.v1.boxes.android.backup(
  'com.example.myapp',
  { boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d' },
);

const content = await response.blob();
console.log(content);
```
- Defined in src/resources/v1/boxes/android.ts:44

backupAll

backupAll(boxID: string, options?: RequestOptions): APIPromise<Response>
Backup all
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<Response>
Example
```
const response = await client.v1.boxes.android.backupAll(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);

const content = await response.blob();
console.log(content);
```
- Defined in src/resources/v1/boxes/android.ts:66

close

close(
    packageName: string,
    params: GboxClient.V1.Boxes.AndroidCloseParams,
    options?: RequestOptions,
): APIPromise<void>
Forces the specified Android application to close inside the box
Parameters
- packageName: string
- params: GboxClient.V1.Boxes.AndroidCloseParams
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.android.close('com.example.myapp', {
  boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
});
```
- Defined in src/resources/v1/boxes/android.ts:84

closeAll

closeAll(boxID: string, options?: RequestOptions): APIPromise<void>
Terminates all running Android applications inside the box
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.android.closeAll(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/android.ts:102

get

get(
    packageName: string,
    params: GboxClient.V1.Boxes.AndroidGetParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidPkg>
Get pkg
Parameters
- packageName: string
- params: GboxClient.V1.Boxes.AndroidGetParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidPkg>
Example
```
const androidPkg = await client.v1.boxes.android.get(
  'com.example.myapp',
  { boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d' },
);
```
- Defined in src/resources/v1/boxes/android.ts:120

getApp

getApp(
    packageName: string,
    params: GboxClient.V1.Boxes.AndroidGetAppParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidApp>
Get installed app info by package name
Parameters
- packageName: string
- params: GboxClient.V1.Boxes.AndroidGetAppParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidApp>
Example
```
const androidApp = await client.v1.boxes.android.getApp(
  'com.example.myapp',
  { boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d' },
);
```
- Defined in src/resources/v1/boxes/android.ts:136

getConnectAddress

getConnectAddress(
boxID: string,
options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidGetConnectAddressResponse>
Get connect address
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidGetConnectAddressResponse>
Example
```
const response =
  await client.v1.boxes.android.getConnectAddress(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
```
- Defined in src/resources/v1/boxes/android.ts:152

install

install(
    boxID: string,
    body: GboxClient.V1.Boxes.AndroidInstallParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidInstallResponse>
Install an Android app on the box
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.AndroidInstallParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidInstallResponse>
Example
```
const response = await client.v1.boxes.android.install(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { apk: fs.createReadStream('path/to/file') },
);
```
- Defined in src/resources/v1/boxes/android.ts:167

listActivities

listActivities(
    packageName: string,
    params: GboxClient.V1.Boxes.AndroidListActivitiesParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidListActivitiesResponse>
Retrieves the list of activities defined in a specific Android package
Parameters
- packageName: string
- params: GboxClient.V1.Boxes.AndroidListActivitiesParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidListActivitiesResponse>
Example
```
const response =
  await client.v1.boxes.android.listActivities(
    'com.example.myapp',
    { boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d' },
  );
```
- Defined in src/resources/v1/boxes/android.ts:190

listApp

listApp(
boxID: string,
options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidListAppResponse>
List all installed apps on the launcher
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidListAppResponse>
Example
```
const response = await client.v1.boxes.android.listApp(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/android.ts:209

listPkg

listPkg(
    boxID: string,
    query?: GboxClient.V1.Boxes.AndroidListPkgParams | null | undefined,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidListPkgResponse>
Retrieves detailed information for all installed pkgs. This endpoint provides comprehensive pkg details.
Parameters
- boxID: string
- query: GboxClient.V1.Boxes.AndroidListPkgParams | null | undefined = {}
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidListPkgResponse>
Example
```
const response = await client.v1.boxes.android.listPkg(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/android.ts:224

listPkgSimple

listPkgSimple(
    boxID: string,
    query?: GboxClient.V1.Boxes.AndroidListPkgSimpleParams | null | undefined,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.AndroidListPkgSimpleResponse>
A faster endpoint to quickly retrieve basic pkg information. This API provides better performance for scenarios where you need to get essential pkg details quickly.
Parameters
- boxID: string
- query: GboxClient.V1.Boxes.AndroidListPkgSimpleParams | null | undefined = {}
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.AndroidListPkgSimpleResponse>
Example
```
const response =
  await client.v1.boxes.android.listPkgSimple(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
```
- Defined in src/resources/v1/boxes/android.ts:245

open

open(
    packageName: string,
    params: GboxClient.V1.Boxes.AndroidOpenParams,
    options?: RequestOptions,
): APIPromise<void>
Launches a specific Android application within the box
Parameters
- packageName: string
- params: GboxClient.V1.Boxes.AndroidOpenParams
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.android.open('com.example.myapp', {
  boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
});
```
- Defined in src/resources/v1/boxes/android.ts:263

restart

restart(
    packageName: string,
    params: GboxClient.V1.Boxes.AndroidRestartParams,
    options?: RequestOptions,
): APIPromise<void>
Closes and immediately reopens the specified Android application inside the box
Parameters
- packageName: string
- params: GboxClient.V1.Boxes.AndroidRestartParams
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.android.restart('com.example.myapp', {
  boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
});
```
- Defined in src/resources/v1/boxes/android.ts:282

restore

restore(
    boxID: string,
    body: GboxClient.V1.Boxes.AndroidRestoreParams,
    options?: RequestOptions,
): APIPromise<void>
Restore
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.AndroidRestoreParams
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.android.restore(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { backup: fs.createReadStream('path/to/file') },
);
```
- Defined in src/resources/v1/boxes/android.ts:302

uninstall

uninstall(
    packageName: string,
    params: GboxClient.V1.Boxes.AndroidUninstallParams,
    options?: RequestOptions,
): APIPromise<void>
Uninstalls an Android app from the box
Parameters
- packageName: string
- params: GboxClient.V1.Boxes.AndroidUninstallParams
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.android.uninstall(
  'com.example.myapp',
  { boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d' },
);
```
- Defined in src/resources/v1/boxes/android.ts:321

Class Android

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GboxClient.V1.Boxes.Android

Properties

Protected_client

Methods

appiumURL

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidAppiumURLResponse>

Example

backup

Parameters

Returns APIPromise<Response>

Example

backupAll

Parameters

Returns APIPromise<Response>

Example

close

Parameters

Returns APIPromise<void>

Example

closeAll

Parameters

Returns APIPromise<void>

Example

get

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidPkg>

Example

getApp

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidApp>

Example

getConnectAddress

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidGetConnectAddressResponse>

Example

install

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidInstallResponse>

Example

listActivities

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidListActivitiesResponse>

Example

listApp

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidListAppResponse>

Example

listPkg

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidListPkgResponse>

Example

listPkgSimple

Parameters

Returns APIPromise<GboxClient.V1.Boxes.AndroidListPkgSimpleResponse>

Example

open

Parameters

Returns APIPromise<void>

Example

restart

Parameters

Returns APIPromise<void>

Example

restore

Parameters

Returns APIPromise<void>

Example

uninstall

Parameters

Returns APIPromise<void>

`Protected`_client