Class adobeDPS-LibraryService
- Extends:
- adobeDPS-LibraryService -> adobeDPS-Service -> adobeDPS-Class
- Platforms:
- iOS, Android, Windows
The service that maintains state information about the library.
Accessible from adobeDPS.libraryService
Constructor
[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
|
|
|
Folio content preview state enum accessor.
|
LibraryService
|
|
|
The current transaction acting on the model.
|
LibraryService
|
Methods
| Method | Defined By | |
|---|---|---|
|
Start a library update transaction.
|
LibraryService
|
|
|
getFolioInfo(productId:String)
Start a Folio Info transaction.
|
LibraryService
|
|
|
getFolioInfoAsEntitled(productId:String, subscriberInfo:Dictionary)
Start a Folio Info transaction.
|
LibraryService
|
|
|
toString()
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.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-LibraryService.instance
The singleton of the LibraryService.
- Platforms:
- iOS, Android, Windows
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
Callback Signature: updatedHandler()
currentTransaction property.
Callback Signature: updatedHandler()
- Platforms:
- iOS, Android, Windows
folioMap
: adobeDPS-DocumentMap
Object containing the map of folios by id
- Platforms:
- iOS, Android, Windows
folioStates
: adobeDPS-FolioState
Folio states enum accessor.
This is where you should access the adobeDPS-FolioState enums from.
This is where you should access the adobeDPS-FolioState enums from.
- Platforms:
- iOS, Android
folioContentPreviewStates
: adobeDPS-FolioContentPreviewState
Folio content preview state enum accessor.
This is where you should access the adobeDPS-FolioContentPreviewState enums from.
This is where you should access the adobeDPS-FolioContentPreviewState enums from.
- Platforms:
- iOS
currentTransaction
: adobeDPS-Transaction
The current transaction acting on the model. This is most likely a adobeDPS-LibraryUpdateTransaction.
- Platforms:
- iOS, Android
Method Details
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.
- Platforms:
- iOS, Android, Windows
Start a Folio Info transaction. This API will only return folio information
if the 'Custom library or store manages issues' setting
is enabled in App Builder, otherwise it will fail with an error.
If this API is called using an R30 viewer or later, entitlement information
will always be requested remotely for the given productId.
On Android: If there is already an active folio info transaction, subsequent calls to getFolioInfo will not return correct results.
| Parameters | ||
|---|---|---|
| productId | String | The productId of the folio to fetch information. |
- Throws:
- Error If there is already an active folio info transaction. (iOS)
- Returns:
- adobeDPS-FolioInfoTransaction The started folio info transaction.
- Platforms:
- iOS, Android
Start a Folio Info transaction. This API will only return folio information
if the 'Custom library or store manages issues' setting
is enabled in App Builder, otherwise it will fail with an error.
| Parameters | ||
|---|---|---|
| productId | String | The productId of the folio to fetch information. |
| subscriberInfo | Dictionary | The subscriberInfo of the folio to fetch information. This parameter is optional. Current supported fields are subscriberID and subscriberType. |
- Deprecated:
- If this API is called using an R30 viewer or later, there is no difference between this API and the getFolioInfo() API. The subscriberInfo passed into this method will be ignored and will instead be populated by values found in the remote entitlement service.
- Throws:
- Error If there is already an active folio info transaction.
- Returns:
- adobeDPS-FolioInfoTransaction The started folio info transaction.
- Platforms:
- iOS
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:26 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:26 GMT-0700 (PDT)