Adobe DPS - Reading SDK 2.32

Class adobeDPS-FolioDataService

Extends:
adobeDPS-FolioDataService -> adobeDPS-Service -> adobeDPS-Class
Platforms:
iOS, Android

FolioDataService allows the access to the different properties of the articles in the folio. ALl the data provided is based on the current display position of the article in Folio.


Accessible from adobeDPS.FolioDataService

Constructor

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

Static Fields

Field Defined By
adobeDPS-FolioDataService.adobeDPS-FolioDataError
The Error codes that are called in the error callback.
FolioDataService
adobeDPS-FolioDataService.instance
The singleton of the FolioDataService.
FolioDataService

Fields

Field Defined By
A signal that indicates that the FolioDataService is ready to be used.
FolioDataService
The total number of articles in the folio
FolioDataService
The total number of articles in the section of the current article
FolioDataService

Methods

Method Defined By
getArticleMetaData(relativeIndex:number, successCallback:Function, errorCallback:Function)
Function used to retrieve the metadata of the current article.
FolioDataService
getArticlePosition(successCallback:Function, errorCallback:Function)
Function used to retrieve the position of the current article.
FolioDataService
Inherited from adobeDPS-Class
Gets the string representation of this instance.
Class Detail
adobeDPS-FolioDataService()
[inner] Create an instance of the FolioDataService.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-FolioDataService.adobeDPS-FolioDataError
The Error codes that are called in the error callback. The following are the error codes that are supported NOVALIDDATA, ARTICLENOTDOWNLOADED

ValueDescription
NOVALIDDATAData requested is not valid
ARTICLENOTDOWNLOADEDMeta data requested for an article which was not downloaded


Platforms:
iOS, Android
adobeDPS-FolioDataService.instance
The singleton of the FolioDataService.
Platforms:
iOS, Android
Field Details
readySignal : adobeDPS-Signal
A signal that indicates that the FolioDataService is ready to be used. It is advisable to wait for this signal to be dispatched before any further interaction with the Service.
Callback Signature: readyHandler()
Platforms:
iOS, Android
totalArticlesInFolio : number
The total number of articles in the folio
Platforms:
iOS, Android
totalArticlesInSection : number
The total number of articles in the section of the current article
Platforms:
iOS
Method Details
getArticleMetaData(relativeIndex:number, successCallback:Function, errorCallback:Function)
Function used to retrieve the metadata of the current article.
Parameters
relativeIndex number The relative index of the article information requested. If the value is 0, it gets the current article's properties. If the value is negative(-1,-2 etc), it gets the properties of article on the left If the value is positive(1, 2 etc), it gets properties of the article on the right.
successCallback Function The callback function that handles the article meta data when operation succeeds.
Callback Signature: successHandler(adobeDPS-ArticleMetaData, relativeIndex)
errorCallback Function The callback function that handles the error when operation fails.
Callback Signature: errorHandler(adobeDPS-FolioDataService.adobeDPS-FolioDataError, errorMessage, relativeIndex)
Platforms:
iOS, Android
getArticlePosition(successCallback:Function, errorCallback:Function)
Function used to retrieve the position of the current article.
Parameters
successCallback Function The callback function that provides the article's current position, when operation succeeds.
Callback Signature: successHandler(adobeDPS-ArticlePosition)
errorCallback Function The callback function that handles the error when operation fails.
Callback Signature: errorHandler(adobeDPS-FolioDataService.adobeDPS-FolioDataError, errorMessage)
Platforms:
iOS, Android
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)