User Interface API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
App
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| appId | String | The unique ID of the app. | Small, 43.0 | 43.0 |
| description | String | A description of the app. | Small, 43.0 | 43.0 |
| developerName | String | The API name of the app. | Small, 43.0 | 43.0 |
| formFactors | String[] | The form factor of the app. One or more of these values:
|
Medium, 43.0 | 43.0 |
| headerColor | String | The primary color for the app as selected by an admin. For example, #0070D2. | Small, 43.0 | 43.0 |
| iconUrl | String | The URL for the app’s icon. | Small, 43.0 | 43.0 |
| isNavAutoTempTabsDisabled | Boolean | If true, the navigation automatically creates temporary tabs settings. | Small, 43.0 | 43.0 |
| isNavPersonalizationDisabled | Boolean | If true, navigation personalization is disabled. | Small, 43.0 | 43.0 |
| isNavTabPersistenceDisabled | Boolean | If true, workspace tabs are cleared for each new console session. | Small, 54.0 | 54.0 |
| isOmniPinnedViewEnabled | Boolean | If true, the Omni-Channel sidebar is enabled. | Small, 60.0 | 60.0 |
| label | String | The label of the app. | Small, 43.0 | 43.0 |
| logoUrl | String | The logo URL of the app as selected by the admin. | Medium, 43.0 | 43.0 |
| mobileStartUrl | String | The mobile launch URL for the app. This field is used with client apps and Experience Builder sites. For sites only, this location is a fully qualified domain name. For other apps, it’s a relative URL. | Medium, 43.0 | 43.0 |
| navItems | Navigation Item[] | The metadata for the navigation tabs of the app. | Big, 43.0 | 43.0 |
| selected | Boolean | If true, this app is the default app for the user. | Big, 43.0 | 43.0 |
| startUrl | String | The launch URL of the app. | Medium, 43.0 | 43.0 |
| type | String | The type of the app. One of these values:
|
Small, 47.0 | 47.0 |
| uiType | String | The UI type for the app. One of these values:
This property was deprecated in API version 47.0. In API version 47.0 and later, use type instead. |
Small, 43.0–46.0 | 43.0–46.0 |
| userNavItems | Navigation Item[] | The user's navigation tabs for the app. | Big, 43.0 | 43.0 |