In this document:
UX1 or CP sends data it generates or data transferred by views to the active view through the named aps.context
set. The data is available only after the view is initialized.
Depending on the used user panel, the following ways of ensuring
data availability are recommended:
In CP, the require
plugin ensures the screen initialization using the aps/ready!
argument:
require([“aps/ready!”], function() {/* Callback function */});
This means you can use the
aps.context
data in the callback function without any additional wait time, because the function is called only after the view is initialized.
In UX1, the aps.context
data is available starting with the onContext
phase.
Property |
Type |
DESCRIPTION |
---|---|---|
|
Boolean |
Indicates whether the view is loaded in the IFrame created by |
|
Enum: |
Indicates if the view is displayed in respectively the eXtra Small (mobile) or Medium Dimension (desktop) environment respectively. |
|
Number |
Level of password strength requirements in the hosting platform. |
|
String |
Base URL to reach the view. This is usually |
|
Object |
Associative set of navigation variables passed to the view. |
|
Object |
Associative set of parameters that a view has passed to the current view when calling the latter using the gotoView method. |
|
Object |
Set of steps in a wizard as explained in the Navigation Processing section. |
|
Object |
Set of shared data generated by each view in a wizard as explained in the Shared Data section. |
|
String |
APS ID of a customer subscription. The view can specify it when sending a REST request to provision or update a resource in a certain subscription as explained in the Specify Subscription ID section. |
|
String |
Current view ID as declared in meta. |
|
Object |
Shows the currency used by the current customer in the Business Support System of the hosting platform. |