Get folio data

  • Since SDK: 20

Get library state information for the folios in the library.

adobe.dps.store.getFolioData

Parameter Type Description
callback

getFolioDataFunction

A developer-supplied function to handle the list of folios. Returned state per folio has the following values: 100, purchasable >= 200<1000 entitlied, downloadable, installable. >= 1000 viewable, update available. NOTE: If no current or cached information is available, the function will return an empty list

getFolioDataFunction

Parameter Type Description
folios

folioArray

A list containing the library state information for the folios in the library.
folio

folio

A list of folios.
productId

string

The store product identifier.
id

string

The unique identifier of the folio.
state

folioState

A FolioState constant.
price

string

A localized string representing the price of the folio.
title

string

Title extracted from the folio metadata.
description

string

Description extracted from the folio metadata.
broker

string

Authority that will entitle the folio.
thirdPartyEntitled

boolean

Indicates whether this folio is entitled by the entitlement server.
folioNumber

string

Metadata field to identify the folio number.
publicationDate

uint

Indicates the date the folio was published returned as unix time (uint).
targetDimensions

string

Dimensions of the folio passed back as a string in the form "1024x768".

API Snippet

getFolioData

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Get Folio Data API</title>
<script type="text/javascript">
function getFolioData()
{
  // call into the getFolioData API
  adobe.dps.store.getFolioData(function(returnedFolios)
    {
      var results = "<ul>";
      for (folio in returnedFolios)
      {
                var folioDate = new Date();
                folioDate.setTime( returnedFolios[folio].publicationDate );
                
        results += "<li>Folio: " + returnedFolios[folio].title + "</li><ul>" +
           "<li>Id: " + returnedFolios[folio].id + "</li>" +
           "<li>ProductId: " + returnedFolios[folio].productId + "</li>" +
           "<li>Price: " + returnedFolios[folio].price + "</li>" +
           "<li>State: " + returnedFolios[folio].state + "</li>" +
           "<li>Broker: " + returnedFolios[folio].broker + "</li>" +
           "<li>thirdPartyEntitled: " + returnedFolios[folio].thirdPartyEntitled + "</li>" +
           "<li>folioNumber: " + returnedFolios[folio].folioNumber + "</li>" +
           "<li>publicationDate: " + folioDate + "</li>" +
           "<li>targetDimensions: " + returnedFolios[folio].targetDimensions + "</li>" +
           "<li>Description: " + returnedFolios[folio].description + "</li>" + 
           "</ul>";
      }
      results += "</ul>";
      document.write(results);
    }
  );
}
</script>
</head>

<body>
<p>Get Folio Data</p>
<button type="button" id="getFolioData" onclick="getFolioData()">Get Folio Data</button>
</body>
</html>