Adobe DPS - Library and Store SDK 2.32

• adobeDPS
• Analytics
• AnalyticsService
• ApplicationContext
• ApplicationState
• ApplicationStateType
• ArchiveTransaction
• AuthenticationService
• AutoArchive
• BackgroundRefreshState
• BaseFolio
• CalendarService
• Class
• ConfigurationService
• ContentPreviewAvailabilityTransaction
• Coordinates
• DeviceService
• DialogService
• DocumentMap
• DownloadTransaction
• EncryptedStorageErrorCodes
• EncryptedStorageOptions
• EncryptedStorageService
• EntitlementType
• Folio
• FolioActivityConfig
• FolioActivityErrorCodes
• FolioActivityRecording
• FolioActivityRecordingStates
• FolioActivityService
• FolioContentPreviewState
• FolioInfoTransaction
• FolioSectionListUpdateTransaction
• FolioState
• FolioStateChangingTransaction
• FolioTransaction
• GeolocationService
• LibraryService
• LibraryUpdateTransaction
• Log
• ModifySubscriptionsListTransaction
• NetworkType
• OAuthRedirectService
• OAuthRedirectServiceErrorCodes
• Position
• PositionError
• PositionOptions
• PreviewContentTransaction
• PreviewImageTransaction
• PurchaseTransaction
• Receipt
• ReceiptService
• RestorePurchasesTransaction
• Section
• Service
• Setting
• SettingsService
• Signal
• SignalBinding
• SubscribeTransaction
• Subscription
• SubscriptionReceipt
• Transaction
• TransactionError
• TransactionErrorType
• TransactionManager
• TransactionState
• UpdateTransaction
• UserSigninTransaction
• UserSignoutTransaction
• ViewTransaction

Namespace adobeDPS

ADOBE CONFIDENTIAL
________________________________________________
Copyright 2012 Adobe Systems Incorporated
All Rights Reserved.

NOTICE: All information contained herein is, and remains the property of Adobe Systems Incorporated and its suppliers, if any. The intellectual and technical concepts contained herein are proprietary to Adobe Systems Incorporated and its suppliers and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Adobe Systems Incorporated. AdobePatentID="2472US01"

To begin working with the API, you must include the Library and Store API script in your HTML. The AdobeLibraryAPI.js can be included with your store files in the viewer or loaded from your server. Once that is done, you can work with the API through the use of one of the service objects. Some examples of available service objects are:

    adobeDPS.libraryService         //Used to retrieve folios and to update the library.
    adobeDPS.authenticationService  //Used for authentication.
    adobeDPS.deviceService          //Used to get device information such as OS or network status.
    adobeDPS.receiptService         //Used to retrieve receipts and get subscription information.
    adobeDPS.settingsService        //Used to retrieve settings for the viewer.
    adobeDPS.analyticsService       //Used to send custom analytics events.
    adobeDPS.configurationService   //Used to retrieve application properties and to navigate between tabs.
    adobeDPS.dialogService          //Used to control dialogs.

Static Fields

	Field	Defined By
	adobeDPS.version : Number The version of this LibraryAPI Interface	adobeDPS
	adobeDPS.uid : String A unique ID used to identify this instance of the API within the greater application.	adobeDPS
	adobeDPS.initializationComplete : adobeDPS-Signal A signal that indicates that the API has finished initializing.	adobeDPS
	adobeDPS.libraryService : adobeDPS-LibraryService The main model object for the library.	adobeDPS
	adobeDPS.transactionManager : adobeDPS-TransactionManager The manager that handles incoming and outgoing transactions.	adobeDPS
	adobeDPS.authenticationService : adobeDPS-AuthenticationService The service to manage user authentication.	adobeDPS
	adobeDPS.deviceService : adobeDPS-DeviceService The service that exposes information about the device that the viewer is currently running on.	adobeDPS
	adobeDPS.receiptService : adobeDPS-ReceiptService The service to manage the user's receipts.	adobeDPS
	adobeDPS.settingsService : adobeDPS-SettingsService Create a new settings service	adobeDPS
	adobeDPS.analyticsService : adobeDPS-AnalyticsService The service to send custom analytics events.	adobeDPS
	adobeDPS.configurationService : adobeDPS-ConfigurationService The service to get viewer configuration information.	adobeDPS
	adobeDPS.dialogService : adobeDPS-DialogService The service to check if this is a dialog or dismiss a dialog.	adobeDPS
	adobeDPS.geolocation : adobeDPS-GeolocationService The service handling the geolocation functionality	adobeDPS
	adobeDPS.calendarService : adobeDPS-CalendarService The service handling the calendar functionality	adobeDPS
	adobeDPS.oauthRedirectService : adobeDPS-OAuthRedirectService The service handling the OAuth authentication functionality	adobeDPS
	adobeDPS.folioActivityService : adobeDPS-FolioActivityService The service handling the folio activity introspection service.	adobeDPS
	adobeDPS.encryptedStorageService : adobeDPS-EncryptedStorageService The service handling the encrypted local service.	adobeDPS
	adobeDPS.log : adobeDPS-Log The instance of our built-in logging mechanism.	adobeDPS

Fields

	Field	Defined By
	DeviceStatus [inner] The status code returned in the update function	adobeDPS
	callbackId [inner] This is the base random Id identifying a callback in the array of callbacks	adobeDPS

Methods

	Method	Defined By
	isDefined(entity) [inner]	adobeDPS
	isValidCallback(callback) [inner]	adobeDPS
	throwErrorIfInvalid(callback, error) [inner]	adobeDPS
	call(func, data) [inner]	adobeDPS

Parameters
entity

Parameters
callback

Parameters
callback
error

Parameters
func
data