Class adobeDPS-ConfigurationService
- Extends:
- adobeDPS-ConfigurationService -> adobeDPS-Service -> adobeDPS-Class
- Platforms:
- iOS, Android, Windows
Service for accessing information about the viewer configuration.
Accessible from adobeDPS.configurationService
Constructor
[inner]
Create an instance of the ConfigurationService.
Static Fields
| Field | Defined By | |
|---|---|---|
|
adobeDPS-ConfigurationService.instance
The singleton of the ConfigurationService.
|
ConfigurationService
|
Fields
| Field | Defined By | |
|---|---|---|
|
applicationStates
: Array
The list of states that this application supports.
|
ConfigurationService
|
|
|
This is the user-accessible location to access ApplicationStateType constants.
|
ConfigurationService
|
|
|
applicationID
: String
The ID of this application as configured in App Builder.
|
ConfigurationService
|
|
|
applicationVersion
: String
The version of this application as configured in App Builder.
|
ConfigurationService
|
|
|
adobeApplicationVersion
: String
The version specified by Adobe each release (e.g.
|
ConfigurationService
|
|
|
The context under which the application was launched or activated.
|
ConfigurationService
|
|
|
Signal to indicate that the application activation context has been updated.
|
ConfigurationService
|
Methods
| Method | Defined By | |
|---|---|---|
|
gotoState(stateLabel:String)
Function used to go to a new application state
|
ConfigurationService
|
|
|
canOpenURL(urlValue:String, callbackFunction:Function)
Function used to check if a URL can be opened by an application.
|
ConfigurationService
|
|
|
toString()
Gets the string representation of this instance.
|
Class Detail
adobeDPS-ConfigurationService()
[inner]
Create an instance of the ConfigurationService.
- This is an internal constructor and shouldn't be called by regular users.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-ConfigurationService.instance
The singleton of the ConfigurationService.
- Platforms:
- iOS, Android, Windows
Field Details
applicationStates
: Array
The list of states that this application supports.
- See:
- adobeDPS-ApplicationState
- Platforms:
- iOS
applicationStateTypes
: adobeDPS-ApplicationStateType
This is the user-accessible location to access ApplicationStateType constants.
- Platforms:
- iOS
applicationID
: String
The ID of this application as configured in App Builder.
- Platforms:
- iOS, Android, Windows
applicationVersion
: String
The version of this application as configured in App Builder.
- Platforms:
- iOS, Android, Windows
adobeApplicationVersion
: String
The version specified by Adobe each release (e.g. 30.1.0).
It is not the application version set by App Builder in the app manifest.
- Platforms:
- Android, Windows
applicationContext
: adobeDPS-ApplicationContext
The context under which the application was launched or activated.
- Platforms:
- iOS
applicationContextUpdatedSignal
: adobeDPS-Signal
Signal to indicate that the application activation context has been updated.
- Platforms:
- iOS
Method Details
gotoState(stateLabel:String)
Function used to go to a new application state
| Parameters | ||
|---|---|---|
| stateLabel | String | The label of this state |
- Platforms:
- iOS
canOpenURL(urlValue:String, callbackFunction:Function)
Function used to check if a URL can be opened by an application. The scheme name of the specified URL is checked to determine if there
is an application installed on the device that can process a URL that begins with that scheme name.
| Parameters | ||
|---|---|---|
| urlValue | String | The URL containing the scheme name to be checked. |
| callbackFunction | Function |
The callback function that provides the boolean results of the check.
Callback Signature: callbackFunction(urlValue, urlCanBeOpened) |
- Platforms:
- iOS, Android
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:39 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:39 GMT-0700 (PDT)