Global

Members

(constant) I

Description:
  • A magic object that can be used as a shortcut for new Input() in expressions like new Input().pressRelease('home').

Source:
See:

A magic object that can be used as a shortcut for new Input() in expressions like new Input().pressRelease('home').

Example
I.press('home').delay(250).release('home')
I.touch(100, 100).delay(250).swipeTo(200, 200).touchUp()

Type Definitions

AppListEntry

Source:
Properties:
Name Type Description
applicationType string
bundleID string
date integer
diskUsage integer
isLaunchable boolean
name string
running boolean
Type:
  • object

CommandResult

Source:
Properties:
Name Type Description
id integer

ID

success boolean

command result

Type:
  • object

FirmwareImage

Source:
Properties:
Name Type Description
id string
name string
Type:
  • object

FridaPsResult

Source:
Properties:
Name Type Description
id integer

ID

exit-status integer
output string

frida-ps output

success boolean

command result

Type:
  • object

Image

Source:
Properties:
Name Type Description
status string

"active"

id string

uuid needed to pass to a createInstance call if this is a kernel

name string

"Image"

type string

"kernel"

self string

uri

file string

file uri

size number
checksum string
encoding string

"encrypted"

project string

Project uuid

createdAt string

ISO datetime string

updatedAt string

ISO datetime string

Type:
  • object

KernelImage

Source:
Properties:
Name Type Description
id string
name string
Type:
  • object

NetmonEntry

Source:
Properties:
Name Type Description
request Object
response Object
startedDateTime integer
duration integer
Type:
  • object

NetmonEntry

Source:
Properties:
Name Type Description
request Object
response Object
startedDateTime integer
duration integer
Type:
  • object

PanicInfo

Source:
Properties:
Name Type Description
flags integer
panic string
stackshot string
other string
ts integer
Type:
  • object

PartitionImage

Source:
Properties:
Name Type Description
id string
name string
Type:
  • object

PeripheralData

Source:
Properties:
Name Type Description
gpsToffs string

GPS time offset

gpsLat string

GPS latitude

gpsLon string

GPS longitude

gpsAlt string

GPS altitude

acOnline string

Is AC charger present, options ['0' , '1']

batteryPresent string

Is battery present, options ['0' , '1']

batteryStatus string

Battery charging status, options ['charging', 'discharging', 'not-charging']

batteryHealth string

Battery health, options ['good', 'overheat', 'dead', 'overvolt', 'failure']

batteryCapacity string

Battery capacity, options 0-100

acceleration string

Acceleration sensor

gyroscope string

Gyroscope sensor

magnetic string

Magnetic sensor

orientation string

Orientation sensor

temperature string

Temperator sensor

proximity string

Proximity sensor

light string

Light sensor

pressure string

Pressure sensor

humidity string

Humidity sensor

Type:
  • object

ProjectKey

Source:
Properties:
Name Type Description
identifier string
label string
key string
kind 'ssh' | 'adb'

public key

fingerprint string
createdAt string

ISO datetime string

updatedAt string

ISO datetime string

Type:
  • object

ProjectQuotas

Source:
Properties:
Name Type Description
cores number

Number of available CPU cores

Type:
  • object

ProvisioningProfileInfo

Source:
Properties:
Name Type Description
name string
uuid string
teamId string
certs Array.<string>
Type:
  • object

RateInfo

Description:
  • Convert microcents to USD using rate / 1000000 / 100 * seconds where rate is rateInfo.onRateMicrocents or rateInfo.offRateMicrocents and seconds is the number of seconds the instance is running.

Source:
Properties:
Name Type Description
onRateMicrocents integer

The amount per second, in microcents (USD), that this instance charges to be running.

offRateMicrocents integer

The amount per second, in microcents (USD), that this instance charges to be stored.

Convert microcents to USD using rate / 1000000 / 100 * seconds where rate is rateInfo.onRateMicrocents or rateInfo.offRateMicrocents and seconds is the number of seconds the instance is running.

Type:
  • object

Response

Source:
Properties:
Name Type Description
statusCode number

HTTP Status Code

result object

JSON encoded error or empty object if successful

Type:
  • object

RotationType

Description:
  • Valid values are 1-4 where each number corresponds to a device orientation.

    1. Portrait: The device is held upright, with the top edge at the top.
    2. Portrait Vertically Inverted (Upside-Down): The device is held upright, but with the top edge at the bottom.
    3. Landscape (Top of Device to the Left): The device is turned sideways with the top edge facing left.
    4. Landscape (Top of Device to the Right): The device is turned sideways with the top edge facing right.
Source:

Valid values are 1-4 where each number corresponds to a device orientation.

  1. Portrait: The device is held upright, with the top edge at the top.
  2. Portrait Vertically Inverted (Upside-Down): The device is held upright, but with the top edge at the bottom.
  3. Landscape (Top of Device to the Left): The device is turned sideways with the top edge facing left.
  4. Landscape (Top of Device to the Right): The device is turned sideways with the top edge facing right.
Type:
  • number

ShellExecResult

Source:
Properties:
Name Type Description
id integer

ID

exit-status integer
output string

command output

success boolean

command result

Type:
  • object

StartOptions

Source:
Properties:
Name Type Description
sockcap boolean

Start the sockcap add-on extension if loaded

paused boolean

Start the instance in a paused state

Type:
  • object

StartOptions

Source:
Properties:
Name Type Description
truncatePcap boolean

Truncate PCAP file

Type:
  • object

StatEntry

Source:
Properties:
Name Type Description
atime integer
ctime integer
entries Array.<object>
entries[].atime integer
entries[].stime integer
entries[].gid integer
entries[].mode integer
entries[].mtime integer
entries[].name string
entries[].size integer
entries[].uid integer
gid integer
mode integer
mtime integer
name string
size integer
uid integer
Type:
  • object

SupportedDevice

Source:
Properties:
Name Type Description
type string
name string
flavor string
description string
model string
firmwares Object
Properties
Name Type Description
version string
buildid string
sha256sum string
sha1sum string
md5sum string
size integer
uniqueid string
metadata string
releasedate string

ISO datetime string

uploaddate string

ISO datetime string

url string
orig_url string
filename string
quotas Object
Properties
Name Type Description
cores integer
cpus integer
Type:
  • object

ThreadInfo

Source:
Properties:
Name Type Description
pid string

process PID

kernelId string

process ID in kernel

name string

process name

threads Array.<object>

process threads

threads[].tid string

thread ID

threads[].kernelId string

thread ID in kernel

Type:
  • object

Token

Source:
Properties:
Name Type Description
token string
expiration string
Type:
  • object

UpgradeOptions

Source:
Properties:
Name Type Description
os string

The target iOS version

osbuild string

Specific build identifier (optional)

Type:
  • object

WebPlayerFeatureSet

Source:
Properties:
Name Type Description
files boolean
apps boolean
network boolean
coretrace boolean
messaging boolean
settings boolean
frida boolean
console boolean
portForwarding boolean
sensors boolean
snapshots boolean
Type:
  • object

WebPlayerSession

Source:
Properties:
Name Type Attributes Description
projectId.required string

The identifier of the project this session is tied to

identifier string

The identifier of this Web Player session

instanceId string

The identifier of the instance this session is tied to

features WebPlayerFeatureSet

Frontend feature set

permissions object

Endpoint permissions (optional)

token string <nullable>

The session's JWT

expiration string <nullable>

Session expiration in simplified extended ISO format (ISO 8601)

Type:
  • object

vmmio

Description:
  • paremeters to export a VM address space range (and IRQ & DMA functionality) over TCP to different models running on different machines or inside a different VM

Source:
Properties:
Name Type Description
start string

start address for beginning of vMMIO range

size string

size of the range to use for vMMIO

irq string

system IRQs, 1-16 ranges must be specified

port string

tcp port for vMMIO usage

paremeters to export a VM address space range (and IRQ & DMA functionality) over TCP to different models running on different machines or inside a different VM

Type:
  • Object