Skip to content

Commit

Permalink
docs: Update the documentation for the mobile: activeAppInfo API (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
mykola-mokhnach committed May 11, 2024
1 parent 154ccee commit 39e52ae
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/reference/execute-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,14 @@ Returns information about the active application.

#### Returned Result

Check the `+ (id<FBResponsePayload>)handleActiveAppInfo:(FBRouteRequest *)request` method in [FBCustomCommands.m](https://github.com/appium/WebDriverAgent/blob/master/WebDriverAgentLib/Commands/FBCustomCommands.m) for more details on the available map entries.
The API returns a map with the following entries

Name | Type | Description | Example
--- | --- | --- | ---
pid | number | The process identifier of the active application | 1234
bundleId | string | The bundle identifier of the active application | com.yolo.myapp
name | string | The name of the active application, if present | Safari
processArguments | map | The map containing actual process arguments. Check the description of the [appium:processArguments capability](./capabilities.md#webdriveragent) for more details on its format. Might be empty if no process arguments have been provided on the app startup. | {"args": ["--help"], "env": {"PATH": "/"}}

### mobile: pressButton

Expand Down

0 comments on commit 39e52ae

Please sign in to comment.