Reference

apps

Install and lifecycle of apps on a session's device. Index · shared schemas · errors.

apps.install

Install, or replace, an app

Input:

{ sessionId: SessionId; source: AppSource; format?: AppFormat }

Output:

InstalledApp

Errors: D, APP_INSTALL_FAILED, TIMEOUT.

Named types: AppFormat, AppSource, InstalledApp, SessionId.

apps.uninstall

Uninstall an app

Input:

{ sessionId: SessionId; bundleId: BundleId }

Output:

{ wasInstalled: boolean }

Errors: D.

Named types: BundleId, SessionId.

apps.launch

Launch an app. If it is already running, ifRunning decides between relaunch (the default) and activate. devServerUrl points an Expo or React Native debug build at its bundler through the Expo dev client link, which also keeps expo-dev-menu off the app (no menu or first-run sheet at launch, no floating button) and stores that in the app preferences.

Input:

{
  sessionId: SessionId
  bundleId: BundleId
  args?: string[]  // ≤ 64 items; each ≤ 4096 chars
  env?: Record<string, string>
  url?: string  // ≤ 8192 chars; /^[A-Za-z][A-Za-z0-9+.-]*:\S+$/
  devServerUrl?: string  // ≤ 2048 chars; url
  ifRunning?: 'relaunch' | 'activate'  // default 'relaunch'
  timeoutMs?: TimeoutMs  // default 30000
}

Output:

{ bundleId: string; state: AppStateOut; pid?: integer; launchedAt: string }

Errors: D, APP_NOT_INSTALLED, APP_LAUNCH_FAILED, APP_CRASHED, TIMEOUT.

Named types: AppStateOut, BundleId, SessionId, TimeoutMs.

apps.terminate

Terminate an app

Input:

{ sessionId: SessionId; bundleId: BundleId }

Output:

{ wasRunning: boolean }

Errors: D, APP_NOT_INSTALLED.

Named types: BundleId, SessionId.

apps.list

List installed apps and their run state

Input:

{
  sessionId: SessionId
  includeSystem?: boolean  // default false
}

Output:

{ apps: AppInfo[] }

Errors: S.

Named types: AppInfo, SessionId.

apps.clearData

Terminate the app and wipe its data (pm clear on Android; on iOS, empty the data container)

Input:

{ sessionId: SessionId; bundleId: BundleId }

Output:

{}

Errors: D, APP_NOT_INSTALLED, APP_INSTALL_FAILED.

Named types: BundleId, SessionId.

apps.openUrl

Open a URL or deep link (the scheme is pre-approved on iOS)

Input:

{
  sessionId: SessionId
  url: string  // ≤ 8192 chars; /^[A-Za-z][A-Za-z0-9+.-]*:\S+$/
  bundleId?: BundleId
}

Output:

{}

Errors: D, APP_NOT_INSTALLED, APP_CRASHED, TIMEOUT.

Named types: BundleId, SessionId.

apps.setPermissions

Grant, revoke or reset app permissions

Input:

{
  sessionId: SessionId
  bundleId: BundleId
  grant?: Permission[]  // ≤ 16 items
  revoke?: Permission[]  // ≤ 16 items
  reset?: Permission[]  // ≤ 16 items
}

Output:

{}

Errors: D, APP_NOT_INSTALLED.

Named types: BundleId, Permission, SessionId.