Adobe DPS - JavaScript Library API

Class adobeDPS-Folio

Extends:
adobeDPS-Folio -> adobeDPS-Class

Representation of a Folio object.

Constructor

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

Fields

Field Defined By
Signal to indicate that this Folio has been updated.
Folio
id : String
The Unique id of this Folio.
Folio
The current transactions acting on this Folio.
Folio
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
price : String
The localized price of this Folio.
Folio
downloadSize : Number
The size of this Folio in Bytes.
Folio
The State of this Folio.
Folio
title : String
The title 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
previewImageURL : String
The local file URL of the preview image for this Folio.
Folio
The receipt associated with this Folio.
Folio
isViewable : Boolean
Whether the Folio is currently able to be viewed.
Folio
isArchivable : Boolean
Whether the folio is currently able to be archived.
Folio
isUpdatable : Boolean
This indicates whether this folio is currently updatable.
Folio
isCompatible : Boolean
This indicates whether this folio is compatible with this version of the viewer.
Folio

Methods

Method Defined By
Start a purchase transaction on this Folio.
Folio
Start a download transaction on this Folio.
Folio
Start an archive transaction on this Folio.
Folio
view()
Start a view transaction on this Folio.
Folio
update()
Start an update transaction on this Folio.
Folio
getPreviewImage(width:Number, height:Number, isPortrait)
Start a preview image transaction on this Folio.
Folio
isFree()
Determine whether this Folio is free.
Folio
Inherited from adobeDPS-Class
Gets the string representation of this instance.
Class Detail
adobeDPS-Folio()
[inner] Creates an instance of a Folio.
Field Details
updatedSignal : adobeDPS-Signal
Signal to indicate that this Folio has been updated. It will pass an array of Strings containing the names of the properties that have been updated.
Callback Signature: updatedHandler([String, ...])
id : String
The Unique id of this Folio.
currentTransactions : Array
The current transactions acting on this Folio. This will be an array of adobeDPS-FolioTransactions. Only one of these adobeDPS-Transactions may be a adobeDPS-FolioStateChangingTransaction, but this may consist of multiple adobeDPS-FolioTransactions.
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.
price : String
The localized price of this Folio. This value is a string that is already localized and contains the currency symbol.
downloadSize : Number
The size of this Folio in Bytes.
state : adobeDPS-FolioState
The State of this Folio.
Default Value:
adobeDPS-FolioState.INVALID
title : String
The title of this Folio. This will be exact value that is entered at publish time.
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.
previewImageURL : String
The local file URL of the preview image for this Folio.
receipt : adobeDPS-Receipt
The receipt associated with this Folio.
isViewable : Boolean
Whether the Folio is currently able to be viewed. When this is true, calling view will cause the folio to begin viewing. This property may change to true during a download if the device supports progressive-download or it may not be true until the folio has been completely installed. In either case, this property should always be used to determine whether adobeDPS-Folio#view may be called.
isArchivable : Boolean
Whether the folio is currently able to be archived. This is provided since it is not always apparent when a Folio may be archived. This property should be used (as opposed to the folio state) to determine whether adobeDPS-Folio#archive may be called.
isUpdatable : Boolean
This indicates whether this folio is currently updatable. When this is true, you may call adobeDPS-Folio#update to update this folio.
isCompatible : Boolean
This indicates whether this folio is compatible with this version of the viewer.
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
download() : adobeDPS-DownloadTransaction
Start a download transaction on this Folio. Requires that the Folio be in the DOWNLOADABLE state.
Throws:
Error If the Folio is in the wrong state or has another active transaction
Returns:
adobeDPS-DownloadTransaction The started download 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
view() : adobeDPS-ViewTransaction
Start a view transaction on this Folio. Requires that adobeDPS-Folio#isViewable be true.
Throws:
Error If adobeDPS-Folio#isViewable is false.
Returns:
adobeDPS-ViewTransaction The started view transaction
update() : adobeDPS-UpdateTransaction
Start an update transaction on this Folio. Requires that adobeDPS-Folio#isUpdatable be true.
Throws:
Error If adobeDPS-Folio#isUpdatable is false.
Returns:
adobeDPS-UpdateTransaction The started update transaction
getPreviewImage(width:Number, height:Number, isPortrait) : adobeDPS-PreviewImageTransaction
Start a preview image transaction on this Folio.
Parameters
width Number The requested width of the preview image
height Number The requested height of the preview image
isPortrait
Throws:
Error If the Folio has another active transaction
Returns:
adobeDPS-PreviewImageTransaction The started preview image transaction
isFree() : Boolean
Determine whether this Folio is free. Returns true if the folio is free.
Returns:
Boolean Whether the Folio is free
©2012 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 01 2012 12:15:46 GMT-0700 (PDT)