Adobe DPS - JavaScript Library API

• adobeDPS
• ApplicationState
• ApplicationStateType
• BaseFolio
• Class
• DeviceService
• DocumentMap
• DownloadTransaction
• EntitlementType
• Folio
• FolioSectionListUpdateTransaction
• FolioState
• FolioStateChangingTransaction
• FolioTransaction
• LibraryUpdateTransaction
• Log
• ModifySubscriptionsListTransaction
• NetworkType
• PreviewImageTransaction
• PurchaseTransaction
• ReadingService
• Receipt
• RestorePurchasesTransaction
• Section
• Service
• Signal
• SignalBinding
• SubscribeTransaction
• Subscription
• SubscriptionReceipt
• SubscriptionService
• Transaction
• TransactionError
• TransactionErrorType
• TransactionManager
• TransactionState
• UpdateTransaction
• UserSigninTransaction
• UserSignoutTransaction
• ViewTransaction

Class adobeDPS-Folio

Extends:

adobeDPS-Folio -> adobeDPS-BaseFolio -> adobeDPS-Class

Representation of a Folio object.

Constructor

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
	publicationDate : Date 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
	isThirdPartyEntitled : Boolean Indicates whether this Folio is entitled by an entitlement server.	Folio
	targetDimensions : String The target device dimensions of this Folio.	Folio
	receipt : adobeDPS-Receipt The receipt associated with this Folio.	Folio
	hasSections : Boolean This indicates whether this folio has sections.	Folio
	sections An associative array containing the sections, indexed by adobeDPS-BaseFolio#id.	Folio
	entitlementTypes : adobeDPS-EntitlementType Entitlement Type enum accessor.	Folio
	updatedSignal : adobeDPS-Signal Signal to indicate that this BaseFolio has been updated.	BaseFolio
	id : String The Unique id of this BaseFolio.	BaseFolio
	currentTransactions : Array The current transactions acting on this BaseFolio.	BaseFolio
	downloadSize : Number The size of this BaseFolio in Bytes.	BaseFolio
	state : adobeDPS-FolioState = adobeDPS-FolioState.INVALID The State of this BaseFolio.	BaseFolio
	previewImageURL : String The local file URL of the preview image for this BaseFolio.	BaseFolio
	title : String The title of this BaseFolio.	BaseFolio
	isCompatible : Boolean This indicates whether this BaseFolio is compatible with this version of the viewer.	BaseFolio
	isDownloadable : Boolean Whether the BaseFolio is currently able to be downloaded.	BaseFolio
	isViewable : Boolean Whether the BaseFolio is currently able to be viewed.	BaseFolio
	isArchivable : Boolean Whether the BaseFolio is currently able to be archived.	BaseFolio
	isUpdatable : Boolean This indicates whether this BaseFolio is currently updatable.	BaseFolio
	entitlementType : adobeDPS-EntitlementType = adobeDPS-EntitlementType.UNKNOWN The EntitlementType of this Folio.	BaseFolio

Methods

	Method	Defined By
	purchase() 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
	archive() Start an archive transaction on this Folio.	Folio
	getSections() Start a FolioSectionsList transaction on this Folio.	Folio
	download() Start a download transaction on this BaseFolio.	BaseFolio
	view() Start a view transaction on this BaseFolio.	BaseFolio
	getPreviewImage(width:Number, height:Number, isPortrait) Start a preview image transaction on this BaseFolio.	BaseFolio
	currentStateChangingTransaction() Helper method to discover the current state changing transaction on a BaseFolio (if any)	BaseFolio
	toString() Gets the string representation of this instance.	Class

Throws:

Error If the folio is in the wrong state or has another active transaction

Returns:

adobeDPS-PurchaseTransaction The started purchase transaction

Returns:

Boolean Whether the Folio is free

Throws:

Error If adobeDPS-Folio#isUpdatable is false.

Returns:

adobeDPS-UpdateTransaction The started update transaction

Throws:

Error If the Folio is in the wrong state or has another active transaction

Returns:

adobeDPS-ArchiveTransaction The started archive transaction

Throws:

Error If the folio does not have sections

Returns:

adobeDPS-FolioSectionListUpdateTransaction The started sectionsList transaction