Adobe DPS - JavaScript Library API

Class adobeDPS-Folio

Extends:
adobeDPS-Folio -> adobeDPS-BaseFolio -> adobeDPS-Class

Representation of a Folio object.

Constructor

adobeDPS-Folio()
[inner] Creates an instance of a Folio.

Fields

Field Defined By
productId : String
The id used to identify this Folio to the broker.
Folio
folioNumber : String
The folioNumber field of this Folio.
Folio
The date this Folio was published.
Folio
folioDescription : String
The description field of this Folio.
Folio
description : String
The description field of this Folio.
Folio
price : String
The localized price of this Folio.
Folio
broker : String
The broker currently associated with this Folio.
Folio
filter : String
The filter field of this Folio.
Folio
Indicates whether this Folio is entitled by an entitlement server.
Folio
targetDimensions : String
The target device dimensions of this Folio.
Folio
The receipt associated with this Folio.
Folio
hasSections : Boolean
This indicates whether this folio has sections.
Folio
An associative array containing the sections, indexed by adobeDPS-BaseFolio#id.
Folio
Entitlement Type enum accessor.
Folio
Inherited from adobeDPS-BaseFolio
Signal to indicate that this BaseFolio has been updated.
Inherited from adobeDPS-BaseFolio
id : String
The Unique id of this BaseFolio.
Inherited from adobeDPS-BaseFolio
The current transactions acting on this BaseFolio.
Inherited from adobeDPS-BaseFolio
downloadSize : Number
The size of this BaseFolio in Bytes.
Inherited from adobeDPS-BaseFolio
The State of this BaseFolio.
Inherited from adobeDPS-BaseFolio
previewImageURL : String
The local file URL of the preview image for this BaseFolio.
Inherited from adobeDPS-BaseFolio
title : String
The title of this BaseFolio.
Inherited from adobeDPS-BaseFolio
isCompatible : Boolean
This indicates whether this BaseFolio is compatible with this version of the viewer.
Inherited from adobeDPS-BaseFolio
isDownloadable : Boolean
Whether the BaseFolio is currently able to be downloaded.
Inherited from adobeDPS-BaseFolio
isViewable : Boolean
Whether the BaseFolio is currently able to be viewed.
Inherited from adobeDPS-BaseFolio
isArchivable : Boolean
Whether the BaseFolio is currently able to be archived.
Inherited from adobeDPS-BaseFolio
isUpdatable : Boolean
This indicates whether this BaseFolio is currently updatable.
Inherited from adobeDPS-BaseFolio
The EntitlementType of this Folio.

Methods

Method Defined By
Start a purchase transaction on this Folio.
Folio
isFree()
Determine whether this Folio is free.
Folio
update()
Start an update transaction on this Folio.
Folio
Start an archive transaction on this Folio.
Folio
Start a FolioSectionsList transaction on this Folio.
Folio
Inherited from adobeDPS-BaseFolio
Start a download transaction on this BaseFolio.
Inherited from adobeDPS-BaseFolio
view()
Start a view transaction on this BaseFolio.
Inherited from adobeDPS-BaseFolio
getPreviewImage(width:Number, height:Number, isPortrait)
Start a preview image transaction on this BaseFolio.
Inherited from adobeDPS-BaseFolio
Helper method to discover the current state changing transaction on a BaseFolio (if any)
Inherited from adobeDPS-Class
Gets the string representation of this instance.
Class Detail
adobeDPS-Folio()
[inner] Creates an instance of a Folio.
Field Details
productId : String
The id used to identify this Folio to the broker.
folioNumber : String
The folioNumber field of this Folio. This will be the exact value that is entered at publish time.
publicationDate : Date
The date this Folio was published.
folioDescription : String
The description field of this Folio. This will be the exact value that is entered at publish time.
description : String
The description field of this Folio. If the folio is free it is the same as the adobeDPS-Folio#folioDescription. On iOS, if the folio is retail, it is the description provided to the broker.
price : String
The localized price of this Folio. This value is a string that is already localized and contains the currency symbol.
broker : String
The broker currently associated with this Folio.
filter : String
The filter field of this Folio. This will be the exact value that is entered at publish time.
isThirdPartyEntitled : Boolean
Indicates whether this Folio is entitled by an entitlement server.
targetDimensions : String
The target device dimensions of this Folio.
receipt : adobeDPS-Receipt
The receipt associated with this Folio.
hasSections : Boolean
This indicates whether this folio has sections.
sections
An associative array containing the sections, indexed by adobeDPS-BaseFolio#id.
entitlementTypes : adobeDPS-EntitlementType
Entitlement Type enum accessor.
This is where you should access the adobeDPS-EntitlementType enums from.
Method Details
purchase() : adobeDPS-PurchaseTransaction
Start a purchase transaction on this Folio. Requires that the Folio be in the PURCHASABLE state.
Throws:
Error If the folio is in the wrong state or has another active transaction
Returns:
adobeDPS-PurchaseTransaction The started purchase transaction
isFree() : Boolean
Determine whether this Folio is free. Returns true if the folio is free.
Returns:
Boolean Whether the Folio is free
update() : adobeDPS-UpdateTransaction
Start an update transaction on this Folio. Requires that adobeDPS-BaseFolio#isUpdatable be true.
Throws:
Error If adobeDPS-Folio#isUpdatable is false.
Returns:
adobeDPS-UpdateTransaction The started update transaction
archive() : adobeDPS-ArchiveTransaction
Start an archive transaction on this Folio. Requires that adobeDPS-Folio#isViewable be true.
Throws:
Error If the Folio is in the wrong state or has another active transaction
Returns:
adobeDPS-ArchiveTransaction The started archive transaction
getSections() : adobeDPS-FolioSectionListUpdateTransaction
Start a FolioSectionsList transaction on this Folio. Requires that hasSections on the Folio be true.
Throws:
Error If the folio does not have sections
Returns:
adobeDPS-FolioSectionListUpdateTransaction The started sectionsList transaction
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 01 2013 13:18:38 GMT-0800 (PST)