Represents the Pega Mobile Client's container object, which is the topmost element
of the public JavaScript API.
The object can be accessed using the launchbox.Container reference.
| Name | Description | Type |
|---|---|---|
| phoneNumber | The phone number of the device. NoteThis parameter is available on certain Android devices only. |
string
|
| deviceId | A unique device identifier. It is generated while the application is being installed on the device, therefore it may be different for each user of this device. Also, it may be different for each application on this device. In most cases it will be different for each device on which the same user is running the same application. In most cases it will not change when the application is stopped and started again. | string
|
| deviceModel | Model name of the device. |
string |
| deviceManufacturer | The name of the device's manufacturer. |
string |
| keepScreenOn | Decides whether the screen should remain on at all times. The parameter's value is set on the native side through the JavaScript bridge. The value is cached by the JavaScript. |
boolean |
| networkStatus | The object provides information about the state of the network connection. It is updated automatically as the value changes on the device. |
object
|
| osName | The name of the operating system. |
string |
| osVersion | The version of the operating system. |
string |
| version | The version of the client application. This property is logged in JavaScript using plain console log. |
string |
The properties keepScreenOn and version are available on Android and iOS platforms only.
| Name | Description | Return type |
|---|---|---|
| addLifecycleListener | Registers any of various lifecycle callbacks. It is used to establish the status of either the Pega Mobile Client or the web application. |
undefined |
| removeLifecycleListener | Removes a listener used to pass various lifecycle callbacks. |
undefined |
| getPlatformSpecificDeviceId | Obtains a value of the |
undefined |
| shutdown | Instantly kills the |
undefined |
The methods addLifecycleListener and
removeLifecycleListener are available on Android and iOS
platforms only.