Adobe DPS - Library and Store SDK 2.32

Class adobeDPS-DialogService

Extends:
adobeDPS-DialogService -> adobeDPS-Service -> adobeDPS-Class
Platforms:
iOS, Android, Windows

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
Ask the dialog service to dismiss the Welcome Screen
DialogService
Ask the dialog service to present the transparent custom webview.
DialogService
Ask the dialog service to dismiss a transparent custom webview with the given url
DialogService
open(url)
Ask the dialog service to present the url with a slide up web view.
DialogService
close()
Ask the dialog service to close any open slide up web view.
DialogService
Ask the dialog service to present the url with the external browser.
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.
Platforms:
iOS, Android, Windows
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, ...])
Platforms:
iOS
isCustomDialogDisplaying : Boolean
Whether a custom dialog is currently displaying
Platforms:
iOS
Method Details
displayCustomDialog()
Ask the dialog service to present the custom dialog.
Throws:
Error if isCustomDialogDisplaying == true
Platforms:
iOS
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.
Platforms:
iOS
dismissWelcomeScreen()
Ask the dialog service to dismiss the Welcome Screen
Platforms:
iOS
displayCustomWebview(url)
Ask the dialog service to present the transparent custom webview. NOTE: url should be a remote url. If requested url is the same as the one already displaying, the request is ignored; otherwise, the existing displaying webview is dismissed first.
Parameters
url
Platforms:
iOS
dismissCustomWebview()
Ask the dialog service to dismiss a transparent custom webview with the given url
Platforms:
iOS
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
Platforms:
iOS, Android, Windows
close()
Ask the dialog service to close any open slide up web view.
Platforms:
iOS
openExternal(url)
Ask the dialog service to present the url with the external browser. NOTE: url only could be external URLs, like http://www.adobe.com, not support relative URLs.
Parameters
url
Platforms:
iOS, Android, Windows
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:26 GMT-0700 (PDT)