Adobe DPS - Library and Store SDK 2.27

Class adobeDPS-DialogService

Extends:
adobeDPS-DialogService -> adobeDPS-Service -> adobeDPS-Class

Service for detecting if the API is hosted as a dialog and dismissing the current dialog.
Accessible from adobeDPS.dialogService

Constructor

adobeDPS-DialogService()
[inner] Create an instance of the DialogService.

Static Fields

Field Defined By
adobeDPS-DialogService.instance
The singleton of the DialogService.
DialogService

Fields

Field Defined By
Signal to indicate that this service has been updated.
DialogService
Whether a custom dialog is currently displaying
DialogService

Methods

Method Defined By
Ask the dialog service to present the custom dialog.
DialogService
Ask the dialog service to dismiss the currently displaying dialog NOTE: The current dialog will almost always be the one hosting this JS API.
DialogService
open(url)
Ask the dialog service to present the url with a slide up web view.
DialogService
Inherited from adobeDPS-Class
Gets the string representation of this instance.
Class Detail
adobeDPS-DialogService()
[inner] Create an instance of the DialogService.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-DialogService.instance
The singleton of the DialogService.
Field Details
updatedSignal : adobeDPS-Signal
Signal to indicate that this service has been updated. It will pass an array of Strings containing the names of the properties that have been updated.
Callback Signature: updatedHandler([String, ...])
isCustomDialogDisplaying : Boolean
Whether a custom dialog is currently displaying
Method Details
displayCustomDialog()
Ask the dialog service to present the custom dialog.
Throws:
Error if isCustomDialogDisplaying == true
dismissCustomDialog()
Ask the dialog service to dismiss the currently displaying dialog NOTE: The current dialog will almost always be the one hosting this JS API.
open(url)
Ask the dialog service to present the url with a slide up web view. NOTE: url only could be external URLs, like http://www.adobe.com, not support relative URLs.
Parameters
url
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jun 24 2013 16:54:19 GMT-0700 (PDT)