Class adobeDPS-BaseFolio

Extends:: adobeDPS-BaseFolio -> adobeDPS-Class
Platforms:: iOS, Android, Windows

Representation of a BaseFolio object.

Constructor

adobeDPS-BaseFolio()

[inner] Creates an instance of a BaseFolio.

Fields

	Field	Defined By
	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

Methods

	Method	Defined By
	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

Class Detail

adobeDPS-BaseFolio()

[inner] Creates an instance of a BaseFolio.

Field Details

updatedSignal : adobeDPS-Signal

Signal to indicate that this BaseFolio has been updated. It will pass an array of Strings containing the names of the properties that have been updated.
Callback Signature: updatedHandler([String, ...])

Platforms:: iOS, Android, Windows

id : String

The Unique id of this BaseFolio.

Platforms:: iOS, Android, Windows

currentTransactions : Array

The current transactions acting on this BaseFolio. 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.

Platforms:: iOS, Android, Windows

downloadSize : Number

The size of this BaseFolio in Bytes. This value will not be available until the download process actually begins.

Platforms:: iOS, Android, Windows

state : adobeDPS-FolioState

The State of this BaseFolio.

Default Value:: adobeDPS-FolioState.INVALID
Platforms:: iOS, Android, Windows

previewImageURL : String

The local file URL of the preview image for this BaseFolio.

Platforms:: iOS, Android, Windows

title : String

The title of this BaseFolio. This will be exact value that is entered at publish time.

Platforms:: iOS, Android, Windows

isCompatible : Boolean

This indicates whether this BaseFolio is compatible with this version of the viewer.

Platforms:: iOS, Android, Windows

isDownloadable : Boolean

Whether the BaseFolio is currently able to be downloaded. When this is true, calling download will cause the BaseFolio to begin downloading. This property should always be used to determine whether adobeDPS-BaseFolio#download may be called.

Platforms:: iOS, Android, Windows

isViewable : Boolean

Whether the BaseFolio is currently able to be viewed. When this is true, calling view will cause the baseFolio 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 baseFolio has been completely installed. In either case, this property should always be used to determine whether adobeDPS-BaseFolio#view may be called.

Platforms:: iOS, Android, Windows

isArchivable : Boolean

Whether the BaseFolio is currently able to be archived. This is provided since it is not always apparent when a BaseFolio may be archived. This property should be used (as opposed to the baseFolio state) to determine whether adobeDPS-BaseFolio#archive may be called.

Platforms:: iOS, Android, Windows

isUpdatable : Boolean

This indicates whether this BaseFolio is currently updatable. When this is true, you may call adobeDPS-BaseFolio#update to update this baseFolio.

Platforms:: iOS, Android, Windows

Method Details

download() : adobeDPS-DownloadTransaction

Start a download transaction on this BaseFolio. Requires that adobeDPS-BaseFolio#isDownloadable be true.

Throws:: Error If the BaseFolio is in the wrong state or has another active transaction
Returns:: adobeDPS-DownloadTransaction The started download transaction
Platforms:: iOS, Android, Windows

view() : adobeDPS-ViewTransaction

Start a view transaction on this BaseFolio. Requires that adobeDPS-BaseFolio#isViewable be true.

Throws:: Error If adobeDPS-BaseFolio#isViewable is false.
Returns:: adobeDPS-ViewTransaction The started view transaction
Platforms:: iOS, Android, Windows

getPreviewImage(width:Number, height:Number, isPortrait) : adobeDPS-PreviewImageTransaction

Start a preview image transaction on this BaseFolio.

Parameters
width	Number	The requested width of the preview image
height	Number	The requested height of the preview image
isPortrait

Throws:: Error If the BaseFolio has another active transaction
Returns:: adobeDPS-PreviewImageTransaction The started preview image transaction
Platforms:: iOS, Android, Windows

currentStateChangingTransaction() : adobeDPS-Transaction

Helper method to discover the current state changing transaction on a BaseFolio (if any)

Returns:: adobeDPS-Transaction The current state changing transaction
Platforms:: iOS, Android

Adobe DPS - Reading SDK 2.32

Class adobeDPS-BaseFolio

Constructor

Fields

Methods