appium_app_lifecycle
Manage mobile app lifecycle actions—activate, terminate, install, uninstall, clear data, query state, and open deep links—for Android and iOS automation sessions.
Instructions
Manage app lifecycle, installation, state, data, and deep links.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Android package or iOS bundle ID; takes precedence over name. | |
| url | No | URL for deep_link (e.g. https://example.com or myapp://path). | |
| name | No | Human-readable app name resolved to an ID; alternative to id. | |
| path | No | App file path or HTTP(S) URL; required for install. Embedded URL downloads require ALLOW_REMOTE_APP_URLS=true (default). Remote sessions resolve app inputs on the remote Appium server. | |
| limit | No | list: return at most this many apps. | |
| action | Yes | activate: foreground app; terminate: stop app; is_installed: check installation; clear: clear app data without uninstalling (all require id or name). install: requires path. uninstall: requires id/name; Android keepData is optional. list: optional iOS applicationType. query_state: get state 0=not installed,1=not running,2=background suspended,3=background,4=foreground (requires id or name). background: send foreground app to background; optional seconds (default 5). deep_link: requires url; id/name is optional. | |
| filter | No | list: only apps whose id or name contains this text (case-insensitive). | |
| seconds | No | Background duration; default 5. Use -1 to remain in background. | |
| keepData | No | Android uninstall: preserve app data and cache. | |
| sessionId | No | Session ID; defaults to the active session. | |
| confirmToken | No | Required to repeat uninstall/clear after the first call returns CONFIRMATION REQUIRED. Single use. | |
| waitForLaunch | No | Android deep_link: wait for the activity to return; default true. | |
| applicationType | No | iOS list filter: User (default) or System. |