Adobe DPS - JavaScript Library API

Class adobeDPS-LibraryService

Extends:
adobeDPS-LibraryService -> adobeDPS-Service -> adobeDPS-Class

The service that maintains state information about the library.
Accessible from adobeDPS.libraryService

Constructor

adobeDPS-LibraryService()
[inner] Create a new LibraryService.

Static Fields

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

Fields

Field Defined By
Signal to indicate updates to the model not associated with the DocumentMap.
LibraryService
Object containing the map of folios by id
LibraryService
Folio states enum accessor.
LibraryService
The current transaction acting on the model.
LibraryService

Methods

Method Defined By
Start a library update transaction.
LibraryService
Inherited from adobeDPS-Class
Gets the string representation of this instance.
Class Detail
adobeDPS-LibraryService()
[inner] Create a new LibraryService.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-LibraryService.instance
The singleton of the LibraryService.
Field Details
updatedSignal : adobeDPS-Signal
Signal to indicate updates to the model not associated with the DocumentMap. This will typically indicate a change in the currentTransaction property.
Callback Signature: updatedHandler()
folioMap : adobeDPS-DocumentMap
Object containing the map of folios by id
folioStates : adobeDPS-FolioState
Folio states enum accessor.
This is where you should access the adobeDPS-FolioState enums from.
currentTransaction : adobeDPS-Transaction
The current transaction acting on the model. This is most likely a adobeDPS-LibraryUpdateTransaction.
Method Details
updateLibrary() : adobeDPS-LibraryUpdateTransaction
Start a library update transaction. This may only be called if there is not already an ongoing library update transaction. When the update transaction is completed, the library will be finished being updated from the fulfillment server. However, this does not mean that entitlements will be updated from the entitlement server. The entitlements will be updated sometime after the library update completes.
Throws:
Error If there is already an active library update transaction.
Returns:
adobeDPS-LibraryUpdateTransaction The started library update transaction.
©2012 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 01 2012 12:15:46 GMT-0700 (PDT)