Archive folio

  • Since SDK: 1.0.0

Archive a folio with the given product ID.

adobe.dps.store.archiveFolio

Parameter Type Description
folioProductId

string

A string containing the product id of the folio to archive.
callback

function

Function that will be called with this signature: {"result":status} where status is one of "succeeded", "failed"

archiveFolioFunction

Parameter Type Description
dictionary

folioResult

A dictionary containing the result status.
"result"

folioStatus

The folio-buying status.

API Snippet

archiveFolio

<!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>viewFolio API</title>
<script type="text/javascript">
function archiveFolio()
{
  if (window.adobedpscontextloaded)
  {
    var productId = document.getElementById("archivefolio").value;
    // call into the archiveFolio API  
    adobe.dps.store.archiveFolio(productId, function(returnedData)
     {
      var status = returnedData['result'];
      document.write("<p>Archive Folio returned with a " + status + " result</p>");
     }
    );
  }
}
</script>
</head>

<body>
<p>Archive Folio</p> 
<input type="text" id="archivefolio" value="folioProductId"/>
<button type="button" onclick="archiveFolio()">Archive Now</button>
</body>
</html>