Available User Actions
This page defines every action that a Level 6 integration must handle and explains how the client performs each action.
In integration Level 6 the Air Doctor Client Back‑End is not present to interpret user interactions. The client application identifies and handles each action defined in the screen definitions.
General Actions
The following actions apply to all screens. Each action includes an integer identifier and a string parameter that directs the client's behavior. Actions that involve server calls run first; after a successful server response, the client execute any local behavior such as closing popups or showing notifications.
General Actions
The following actions apply to all screens. Each action includes an integer identifier and a string parameter that directs the client's behavior.
The client sends the server call first. After a successful server response, the client runs local behavior such as closing popups or showing notifications.
Action Definitions
The table defines each action, its identifier, the required parameter, and the corresponding client behavior.
Device and Utility Actions
| Action | ID | Parameter | Client Behavior |
|---|---|---|---|
| Browser | 1 | URL | Open the URL in the user’s browser. On web, open in a new tab. On native platforms, use the system browser or an in-app browser. |
| Copy to clipboard | 2 | Text | Copy the provided string to the clipboard. |
Permission Requests
| Action | ID | Parameter | Client Behavior |
|---|---|---|---|
| Camera permission | 3 | Endpoint | Request camera access from the OS. After the user grants or denies access, call the PATCH endpoint to update the server. |
| Microphone permission | 4 | Endpoint | Request microphone access and call the PATCH endpoint. |
| Pushes permission | 5 | Endpoint | Request push notification access and call the PATCH endpoint. |
| Location permission | 6 | Endpoint | Request location or GPS access and call the PATCH endpoint. |
| Coordinates | 7 | Endpoint | Obtain device coordinates after permission and call the PATCH endpoint with the coordinates. |
Server Calls
| Action | ID | Parameter | Client Behavior |
|---|---|---|---|
| Page / Put | 8 | Endpoint | Perform a PUT request to the endpoint and open the page from the response. See the PUT documentation for response rules. |
| Patch | 9 | Endpoint | Perform a PATCH request to the endpoint and update the current screen by using the returned patches. |
| Save / Post | 10 | Endpoint | Perform a POST request to the endpoint, including parameters or file uploads if needed. Handle response headers (X-Close, X-Refresh, etc.) as defined in the POST documentation. |
These actions apply only to Video type pages.
Video Controls
| Action | ID | Parameter | Client Behavior |
|---|---|---|---|
| Camera | 11 | Alternative icon | Toggle the camera on or off. The primary icon shows the active state. The parameter defines the icon that displays after toggling. |
| Flip | 12 | Alternative icon | Switch between available cameras. The parameter defines the icon that displays after switching. |
| Mute | 13 | Alternative icon | Toggle the microphone on or off. The parameter defines the icon that displays after toggling. |
| Interpreter hangup | 14 | Endpoint | Disconnect an interpreter from the call and perform a PATCH request to the endpoint. |
Photo Source Page Actions
The photo source page appears when a user selects an image for an upload field. Each action's parameter identifies the field that receives the selected file.
| Action | ID | Parameter | Client Behavior |
|---|---|---|---|
| From gallery | 15 | Field reference | Open the device’s gallery and allow the user to select an image for the referenced field. |
| From camera | 16 | Field reference | Launch the camera, allow the user to take a photo, and assign it to the referenced field. |
| From file | 17 | Field reference | Present a file browser so the user selects a file and assigns it to the referenced field. |
Summary
Actions define how the client responds to user interactions at Level 6. Because the client backend is not active at Level 6, the application maps each action to the correct behavior: making API calls, requesting permissions, opening pages, or updating the UI.
Action Flow
Action → Optional permission → Server call → Local UI behavior
Always send server calls before any local behavior and follow response headers to remain aligned with the server state. For details about endpoint rules and response handling, see the relevant documentation: