AndroidInstance

AndroidInstance

TCGSDK - AndroidInstance submodule related methods

All AndroidInstance methods must be called after normal CloudGamingWebSDK TCGSDK.init

AndroidInstance is a submodule of TCGSDK, used to operate Android devices, including the following capabilities:

  1. Connect to a single instance to view the cloud phone screen and perform various operations.
  2. Preview multiple cloud phone screens via screenshots.
  3. Other functional operations.

Example

const AndroidInstance = TCGSDK.AndroidInstance()

Members

inputText :void

When input box is focused quickly send content without copying to clipboard

Type:
  • void
Example
AndroidInstance.inputText({content: 'abc'});

switchIME :void

Switch IME

Type:
  • void
Example
AndroidInstance.switchIME({ime: 'local'});

Methods

setMaster(params) → {void}

Set master

Example
AndroidInstance.setMaster({instanceId: 'cai-xxx1'});
Parameters:
Name Type Description
params Object
Properties
Name Type Description
instanceId string

Master's instanceId
Returns:
Type
void

startSync(params) → {void}

Default Value:
  • Full synchronization

Start sync based on the accessed instanceIds

Example
AndroidInstance.startSync({instanceIds: ['cai-xxx1', 'cai-xxx2']});
Parameters:
Name Type Description
params Object
Properties
Name Type Description
instanceIds Array

string[] List of devices to synchronize
Returns:
Type
void

stopSync() → {void}

Stop sync (All instance ids)

Example
AndroidInstance.stopSync();
Returns:
Type
void

requestStream(param) → {void}

Request streaming by streamName

Example
TCGSDK.requestStream({streamName: 'high'});
Parameters:
Name Type Description
param Object
Properties
Name Type Attributes Default Description
streamName 'low' | 'mid' | 'high' <optional>
 'high'

Default stream name - 'high'
Returns:
Type
void

setSyncList(param) → {void}

Set sync list

Example
TCGSDK.setSyncList({list: ['cai-xxxx-xxx1', 'cai-xxxx-xxx2']});
Parameters:
Name Type Description
param Object
Properties
Name Type Description
list Array.<string>

List of instanceIds to synchronize
Returns:
Type
void

joinGroupControl(params) → {void}

Join group control by instance id

Example
AndroidInstance.joinGroupControl({instanceIds: ['cai-xxx1', 'cai-xxx2']});
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
instanceIds Array.<string>

List of instances to join
clientSessions Array.<string> <optional>

clientSession
Returns:
Type
void

leaveGroupControl(params) → {void}

Leave group control by instance id

Example
AndroidInstance.leaveInstances({instanceIds: ['cai-xxx1', 'cai-xxx2']});
Parameters:
Name Type Description
params Object
Properties
Name Type Description
instanceIds Array.<string>
Returns:
Type
void

setImageEvent(params) → {void}

Set screenshot event

Example
AndroidInstance.setImageEvent({interval: 10, quality: 50});
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
interval number

Screenshot event interval in milliseconds
quality number <optional>

Screenshot quality, range 0-100
Returns:
Type
void

getInstanceImage(params) → {object}

Properties:
Name Type Description
url string

Get instance screenshot

Example
const {url} = AndroidInstance.getInstanceImage({instanceId: 'cai-xxx1'});
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
instanceId string

Instance Id
quality number <optional>

Screenshot quality, range 0-100, default 20
screenshot_width number <optional>

Screenshot width
screenshot_height number <optional>

Screenshot height
Returns:
Type
object

upload(params) → {Promise.<object>}

Upload file to instance

By default, files are uploaded to the /sdcard/Download directory. Use path to specify a different directory (only under /sdcard/)

Example
AndroidInstance.upload({instanceId: 'cai-xxx1', files: [{file: file1, path: '/sdcard/xxx/'}, {file: file2, path: '/sdcard/xxx/'}]});
Parameters:
Name Type Description
params Object
Properties
Name Type Description
instanceId string

Instance Id
files Array.<Object>

Files

Properties
Name Type Description
file File

file
path string

path
Returns:
Type
Promise.<object>

uploadMedia(params) → {Promise.<object>}

Upload file to instance

By default, files are uploaded to the /data/media/0/DCIM directory

Example
AndroidInstance.uploadMedia({instanceId: 'cai-xxx1', files: [{file: file1}, {file: file2}]});
Parameters:
Name Type Description
params Object
Properties
Name Type Description
instanceId string

Instance Id
files Array.<Object>

Files

Properties
Name Type Description
file File

file
Returns:
Type
Promise.<object>

getInstanceDownloadAddress(params) → {object}

Properties:
Name Type Description
address string

Get instance download address

Example
const {address} = AndroidInstance.getInstanceDownloadAddress({instanceId: 'cai-xxx1', path: '/sdcard/xxx/'});
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
instanceId string

Instance Id
path string <optional>

Download path
Returns:
Type
object

getInstanceDownloadLogcatAddress(params) → {object}

Properties:
Name Type Description
address string

Get instance Logcat download address

Example
const {address} = AndroidInstance.getInstanceDownloadLogcatAddress({instanceId: 'cai-xxx1', recentDays: 3});
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
instanceId string

Instance Id
recentDays string <optional>

Recent days (0 for all logs)
Returns:
Type
object

transMessage(params) → {void}

Send App binder message

For single connection only

Example
AndroidInstance.transMessage({packageName: 'com.example.myapplication', message: 'abc123'});
Parameters:
Name Type Description
params Object
param.packageName string

PackageName
param.message string

Message
Returns:
Type
void

distributeApp(params) → {void}

Distribute App

Example
AndroidInstance.distributeApp({packageName: 'com.example.myapplication'});
Parameters:
Name Type Description
params Object
param.packageName string

PackageName
Returns:
Type
void

preserveCleanApp(params) → {void}

Preserve Clean App

Example
AndroidInstance.preserveCleanApp({preservePackageNames: ["tv.danmaku.bili","tv.danmaku.bili2"]});
Parameters:
Name Type Description
params Object
param.preservePackageNames string

preservePackageNames
Returns:
Type
void

keepFrontApp(params) → {void}

Keep app in front

Example
AndroidInstance.keepFrontApp({packageName: "tv.danmaku.bili"});
Parameters:
Name Type Attributes Description
params Object
param.packageName string

packageName
param.enable string <optional>

enable
Returns:
Type
void

setLocation(params) → {Promise.<BatchTaskResponse>}

Set device GPS information

Example
AndroidInstance.setLocation({'cai-xxx1': {Longitude: 113.32412, Latitude: 23.124124}, 'cai-xxx2': {Longitude: 114.32412, Latitude: 24.124124}})
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object
Properties
Name Type Description
Longitude number
Latitude number
Returns:
Type
Promise.<BatchTaskResponse>

setResolution(params) → {Promise.<BatchTaskResponse>}

Set device Resolution

Example
AndroidInstance.setResolution({'cai-xxx1': {Width: 720, Height: 1080}, {'cai-xxx2': {Width: 720, Height: 1080}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object
Properties
Name Type Description
Width number
Height number
DPI number
Returns:
Type
Promise.<BatchTaskResponse>

paste(params) → {Promise.<BatchTaskResponse>}

Paste text

Example
AndroidInstance.paste({'cai-xxx1': {Text: 'abc'}, {'cai-xxx2': {Text: '123'}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object
Properties
Name Type Description
Text string

Text to paste
Returns:
Type
Promise.<BatchTaskResponse>

sendClipboard(params) → {Promise.<BatchTaskResponse>}

Send text to clipboard

Example
AndroidInstance.sendClipboard({'cai-xxx1': {Text: 'abc'}, {'cai-xxx2': {Text: '123'}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object
Properties
Name Type Description
Text string

Content to send
Returns:
Type
Promise.<BatchTaskResponse>

shake(params) → {Promise.<BatchTaskResponse>}

Shake device

Example
AndroidInstance.shake({'cai-xxx1': {}, {'cai-xxx2': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value is an empty object {}
Returns:
Type
Promise.<BatchTaskResponse>

setSensor(params) → {Promise.<BatchTaskResponse>}

Set device sensor information

Example
AndroidInstance.setSensor({'cai-xxx1': {Type: 'accelerometer', Values: [10, 10, 10]},  {'cai-xxx2': {Type: 'gyroscope', Values: [10, 10, 10]}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object
Properties
Name Type Description
Type 'accelerometer' | 'gyroscope'

Sensor type: accelerometer or gyroscope
Values Array.<string>

Sensor values, array length 3, representing x/y/z axis values
Returns:
Type
Promise.<BatchTaskResponse>

sendTransMessage(params) → {Promise.<BatchTaskResponse>}

Send App binder message

Example
AndroidInstance.sendTransMessage({'cai-xxx1': {PackageName: 'com.example.myapplication', Msg: 'abc123'}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value is an empty object {}

Properties
Name Type Description
PackageName string

PackageName
Msg string

Message
Returns:
Type
Promise.<BatchTaskResponse>

describeInstanceProperties(params) → {Promise.<DescribeInstancePropertiesResponse>}

Describe instance properties

Example
AndroidInstance.describeInstanceProperties({'cai-xxx1': {}, {'cai-xxx2': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value is an empty object {}
Returns:
Type
Promise.<DescribeInstancePropertiesResponse>

modifyInstanceProperties(params) → {Promise.<BatchTaskResponse>}

Modify instance properties

Example
AndroidInstance.ModifyInstanceProperties({'cai-xxx1': {
 DeviceInfo: {
       Brand: 'Samsung',
       Model: 'Galaxy S24',
     },
   ProxyInfo: {
     Enabled: true,
     Protocol: 'socks5',
     Host: 'proxy.example.com',
     Port: 1080,
     User: 'user123',
     Password: 'pass123',
   },
   GPSInfo: {
     Longitude: 121.4737,
     Latitude: 31.2304,
   },
   SIMInfo: {
     State: 1,
     PhoneNumber: '+8613812345678',
     IMSI: '460001234567890',
     ICCID: '89860123456789012345',
   },
   LocaleInfo: {
     Timezone: 'Asia/Shanghai',
   },
   LanguageInfo: {
    Language: 'zh',
    Country: 'CN',
  },
  ExtraProperties: [
    {
      Key: 'custom_property1',
      Value: 'value1',
    },
    {
      Key: 'custom_property2',
      Value: 'value2',
    },
  ]
}})
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Attributes Description
DeviceInfo Object <optional>

DeviceInfo

Properties
Name Type Attributes Description
Brand string <optional>

DeviceInfo - Brand
Model string <optional>

DeviceInfo - Model
ProxyInfo Object <optional>

ProxyInfo

Properties
Name Type Attributes Description
Enabled boolean <optional>

ProxyInfo - Enabled
Protocol string <optional>

ProxyInfo - Protocol
Host string <optional>

ProxyInfo - Host
Port number <optional>

ProxyInfo - Port
User string <optional>

ProxyInfo - User
Password string <optional>

ProxyInfo - Password
GPSInfo Object <optional>

GPSInfo

Properties
Name Type Attributes Description
Longitude number <optional>

GPSInfo - Longitude
Latitude number <optional>

GPSInfo - Latitude
SIMInfo Object <optional>

SIMInfo

Properties
Name Type Attributes Description
State number <optional>

SIMInfo - State
PhoneNumber string <optional>

SIMInfo - PhoneNumber
IMSI string <optional>

SIMInfo - IMSI
ICCID string <optional>

SIMInfo - ICCID
LocaleInfo Object <optional>

LocaleInfo

Properties
Name Type Attributes Description
Timezone string <optional>

LocaleInfo - Timezone
LanguageInfo Object <optional>

LanguageInfo

Properties
Name Type Attributes Description
Language string <optional>

LanguageInfo - Language
Country string <optional>

LanguageInfo - Country
ExtraProperties Array.<Object> <optional>

ExtraProperties

Properties
Name Type Attributes Description
Key string <optional>

ExtraProperties - Key
Value string <optional>

ExtraProperties - Value
Returns:
Type
Promise.<BatchTaskResponse>

listUserApps(params) → {Promise.<ListUserAppsResponse>}

Query user installed apps

Example
AndroidInstance.listUserApps({'cai-xxx1': {}, {'cai-xxx2': {}})
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value is an empty object {}
Returns:
Type
Promise.<ListUserAppsResponse>

modifyKeepFrontAppStatus(params) → {Promise.<BatchTaskResponse>}

Modify foreground app keep-alive status

Example
AndroidInstance.modifyKeepFrontAppStatus({'cai-xxx1': {"PackageName": "com.example.app", "Enable": true, "RestartInterValSeconds": 5}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
PackageName string

PackageName
Enable boolean

Enable
RestartInterValSeconds number

Maximum interval for restarting
Returns:
Type
Promise.<BatchTaskResponse>

describeKeepFrontAppStatus(params) → {Promise.<object>}

Query foreground app keep-alive status

Example
AndroidInstance.describeKeepFrontAppStatus({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<object>

unInstallByPackageName(params) → {Promise.<BatchTaskResponse>}

Uninstall app

Example
AndroidInstance.unInstallByPackageName({'cai-xxx1': {"PackageName": "com.unwanted.app"}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
PackageName string

PackageName
Returns:
Type
Promise.<BatchTaskResponse>

startApp(params) → {Promise.<BatchTaskResponse>}

Start app

Example
AndroidInstance.startApp({'cai-xxx1': {"PackageName": "com.launch.app", "ActivityName": "MainActivity"}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
PackageName string

PackageName
ActivityName string

ActivityName
Returns:
Type
Promise.<BatchTaskResponse>

stopApp(params) → {Promise.<BatchTaskResponse>}

Stop app

Example
AndroidInstance.stopApp({'cai-xxx1': {"PackageName": "com.running.app"}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
PackageName string

PackageName
Returns:
Type
Promise.<BatchTaskResponse>

clearAppData(params) → {Promise.<BatchTaskResponse>}

Clear app data

Example
AndroidInstance.clearAppData({'cai-xxx1': {"PackageName": "com.data.app"}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
PackageName string

PackageName
Returns:
Type
Promise.<BatchTaskResponse>

enableApp(params) → {Promise.<BatchTaskResponse>}

Enable app

Example
AndroidInstance.enableApp({'cai-xxx1': {"PackageName": "com.disabled.app"}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
PackageName string

PackageName
Returns:
Type
Promise.<BatchTaskResponse>

disableApp(params) → {Promise.<BatchTaskResponse>}

Disable app

Example
AndroidInstance.disableApp({'cai-xxx1': {"PackageName": "com.disabled.app"}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
PackageName string

PackageName
Returns:
Type
Promise.<BatchTaskResponse>

startCameraMediaPlay(params) → {Promise.<BatchTaskResponse>}

Play media file on camera

Example
AndroidInstance.startCameraMediaPlay({'cai-xxx1': {"FilePath": "/sdcard/video.mp4", "Loops": 3}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
FilePath string

FilePath
Loops string

Number of loops, negative values indicate infinite loops
Returns:
Type
Promise.<BatchTaskResponse>

stopCameraMediaPlay(params) → {Promise.<BatchTaskResponse>}

Stop playing media file on camera

Example
AndroidInstance.stopCameraMediaPlay({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<BatchTaskResponse>

describeCameraMediaPlayStatus(params) → {Promise.<DescribeCameraMediaPlayStatusResponse>}

Query current camera media play status

Example
AndroidInstance.describeCameraMediaPlayStatus({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<DescribeCameraMediaPlayStatusResponse>

displayCameraImage(params) → {Promise.<BatchTaskResponse>}

Display image on camera

Example
AndroidInstance.displayCameraImage({'cai-xxx1': {"FilePath": "/sdcard/image.jpg"}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
FilePath string

FilePath
Returns:
Type
Promise.<BatchTaskResponse>

addKeepAliveList(params) → {Promise.<BatchTaskResponse>}

Add background keep-alive apps

Example
AndroidInstance.addKeepAliveList({'cai-xxx1': {"AppList": ["com.wechat", "com.alipay", "com.dingtalk"]}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
AppList Array.<string>

AppList
Returns:
Type
Promise.<BatchTaskResponse>

removeKeepAliveList(params) → {Promise.<BatchTaskResponse>}

Remove background keep-alive apps

Example
AndroidInstance.removeKeepAliveList({'cai-xxx1': {"AppList": ["com.wechat", "com.alipay", "com.dingtalk"]}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
AppList Array.<string>

AppList
Returns:
Type
Promise.<BatchTaskResponse>

setKeepAliveList(params) → {Promise.<BatchTaskResponse>}

Override background keep-alive apps

Example
AndroidInstance.setKeepAliveList({'cai-xxx1': {"AppList": ["com.wechat", "com.alipay", "com.dingtalk"]}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
AppList Array.<string>

AppList
Returns:
Type
Promise.<BatchTaskResponse>

describeKeepAliveList(params) → {Promise.<DescribeKeepAliveListResponse>}

Query background keep-alive apps

Example
AndroidInstance.describeKeepAliveList({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<DescribeKeepAliveListResponse>

clearKeepAliveList(params) → {Promise.<BatchTaskResponse>}

Clear background keep-alive apps

Example
AndroidInstance.clearKeepAliveList({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<BatchTaskResponse>

mute(params) → {Promise.<BatchTaskResponse>}

Mute switch

Example
AndroidInstance.mute({'cai-xxx1': {Mute: true}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
Mute boolean

Mute
Returns:
Type
Promise.<BatchTaskResponse>

mediaSearch(params) → {Promise.<MediaSearchResponse>}

Media library file search

Example
AndroidInstance.mediaSearch({'cai-xxx1': {"Keyword": "abc"}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
Keyword boolean

Keyword
Returns:
Type
Promise.<MediaSearchResponse>

reboot(params) → {Promise.<BatchTaskResponse>}

Reboot instance

Example
AndroidInstance.reboot({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<BatchTaskResponse>

listAllApps(params) → {Promise.<ListAllAppsResponse>}

Query all apps list

Example
AndroidInstance.listAllApps({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<ListAllAppsResponse>

moveAppBackground(params) → {Promise.<BatchTaskResponse>}

Move app to background

Example
AndroidInstance.moveAppBackground({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<BatchTaskResponse>

addAppInstallBlackList(params) → {Promise.<BatchTaskResponse>}

Add app install blacklist

If the app is already installed, it will be uninstalled when added

Example
AndroidInstance.addAppInstallBlackList({'cai-xxx1': {"AppList": ["com.wechat", "com.alipay", "com.dingtalk"]}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
AppList Array.<string>

AppList
Returns:
Type
Promise.<BatchTaskResponse>

removeAppInstallBlackList(params) → {Promise.<BatchTaskResponse>}

Remove app install blacklist

Example
AndroidInstance.removeAppInstallBlackList({'cai-xxx1': {"AppList": ["com.wechat", "com.alipay", "com.dingtalk"]}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
AppList Array.<string>

AppList
Returns:
Type
Promise.<BatchTaskResponse>

setAppInstallBlackList(params) → {Promise.<BatchTaskResponse>}

Override app install blacklist

Example
AndroidInstance.setAppInstallBlackList({'cai-xxx1': {"AppList": ["com.wechat", "com.alipay", "com.dingtalk"]}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value

Properties
Name Type Description
AppList Array.<string>

AppList
Returns:
Type
Promise.<BatchTaskResponse>

describeAppInstallBlackList(params) → {Promise.<DescribeAppInstallBlackListResponse>}

Query app install blacklist

Example
AndroidInstance.describeAppInstallBlackList({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<DescribeAppInstallBlackListResponse>

clearAppInstallBlackList(params) → {Promise.<BatchTaskResponse>}

Clear app install blacklist

Example
AndroidInstance.clearAppInstallBlackList({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<BatchTaskResponse>

getNavVisibleStatus(params) → {Promise.<GetNavVisibleStatusResponse>}

Get system navigation bar visibility status

Example
AndroidInstance.getNavVisibleStatus({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId

Properties
Name Type Description
key string

Device instanceId
value Object

value
Returns:
Type
Promise.<GetNavVisibleStatusResponse>

getSystemMusicVolume(params, {string) → {Promise.<GetSystemMusicVolumeResponse>}

Get system media volume level

Example
AndroidInstance.getSystemMusicVolume({'cai-xxx1': {}});
Parameters:
Name Type Description
params Object

key is instanceId
{string

params.key - Device instanceId
params.value Object

value
Returns:
Type
Promise.<GetSystemMusicVolumeResponse>