Home > API Reference Documentation > realm.view
realm.view
The realm.view
action is used to load up all the realm details.
Property | Required | Description |
realm | no | If not specified, it uses the main realm the user is configured for |
auto_net_token | no | For the SDK use, set to true if you want to automatically be able to communicate with Numera.Net and your realm is configured to only allow this server-server and not for any realm requested by the user (should be used in multi-realm implementations where your SDK application allows multiple users from multiple realms). |
Output
The result
object will contain the realm information.
Property | Description |
id | realm id |
realm | realm |
name | partner name (should be same as realm) |
ota_version | current version for the realm |
ota_release | current release, will have either version OR release defined, not both |
ota_variants | array of allowable variants, each object will have a variant and a description |
psap_enabled | psap services enabled |
fall_detection_version | 1 or 2 |
late_fall_minute_threshold | number of minutes for a fall to be considered "in the past" when a call comes in - determines when the old call popup displays on the call page |
settings | current configuration settings from the system and realm hierarchy as an array of objects with each one containing: |
name
- Setting name
value
- Setting value
source
- Will tell you where the setting comes from, SYSTEM or the name of the realm|
platform_parameters | libris platform parameters for the realm, defines items such as short code, etc., array of objects containing: |
name
- Setting name
value
- Setting value
source
- Will tell you where the setting comes from, SYSTEM or the name of the realm|
numera_net_token | contains the numera net token details if requested, used internally by the SDK |
Possible Status Codes
Status Code | Reason | Description |
1000 | NO_REALM_ACCESS | User does not have access to that realm |
1001 | REALM_NOT_FOUND | The realm is not found |