Class adobeDPS-PreviewImageTransaction

Extends:: adobeDPS-PreviewImageTransaction -> adobeDPS-FolioTransaction -> adobeDPS-Transaction -> adobeDPS-Class
Platforms:: iOS, Android, Windows

A Transaction that is used to download a BaseFolio Preview Image.

Constructor

adobeDPS-PreviewImageTransaction(folio:adobeDPS-BaseFolio, isPortrait:Boolean, width:Number, height:Number)

[inner] Create a Preview Image Transaction

Fields

	Field	Defined By
	isPortrait : Boolean Whether the image requested should be portrait or landscape.	PreviewImageTransaction
	width : Number The requested width of the preview image.	PreviewImageTransaction
	height : Number The requested height of the preview image.	PreviewImageTransaction
	previewImageURL : String The resulting image URL of this transaction.	PreviewImageTransaction
	folio : adobeDPS-BaseFolio The BaseFolio that this transaction is acting on	FolioTransaction
	stateChangedSignal : adobeDPS-Signal Signal to indicate that the state of this transaction has changed.	Transaction
	completedSignal : adobeDPS-Signal Signal to indicate that the transaction has completed.	Transaction
	progressSignal : adobeDPS-Signal Signal to indicate transaction progress.	Transaction
	id : String The Unique id of this Transaction.	Transaction
	state : adobeDPS-TransactionState The state of this Transaction.	Transaction
	progress : Number The progress of this Transaction.	Transaction
	error : adobeDPS-TransactionError The TransactionError associated with this transaction, assuming an error has occurred.	Transaction
	isCancelable : Boolean = false Whether this Transaction can be canceled.	Transaction
	isPausable : Boolean = false Whether this Transaction can be paused.	Transaction
	isDeterminate : Boolean = false Whether this Transaction is determinate (has progress).	Transaction
	isFailureTerminal : Boolean = false Whether failure of the transaction is a terminal state.	Transaction

Methods

	Method	Defined By
	start() Start a folio transaction.	FolioTransaction
	isFolioStateChangingTransaction() Whether this transaction is of type FolioStateChangingTransaction	Transaction
	start() Start this transaction.	Transaction
	pause() Pauses a transaction.	Transaction
	resume() Resumes a paused transaction.	Transaction
	cancel() Cancels a transaction.	Transaction
	toString() Gets the string representation of this instance.	Class

Class Detail

adobeDPS-PreviewImageTransaction(folio:adobeDPS-BaseFolio, isPortrait:Boolean, width:Number, height:Number)

[inner] Create a Preview Image Transaction

Parameters
folio	adobeDPS-BaseFolio	The folio that this transaction is acting on
isPortrait	Boolean	Whether the preview should be portrit or landscape
width	Number	The requested width of the image
height	Number	The requested height of the image

Throws:: {Error} If the folio passed in is invalid or not a BaseFolio

Field Details

isPortrait : Boolean

Whether the image requested should be portrait or landscape.

Platforms:: iOS, Android, Windows

width : Number

The requested width of the preview image.

Platforms:: iOS, Android, Windows

height : Number

The requested height of the preview image.

Platforms:: iOS, Android, Windows

previewImageURL : String

The resulting image URL of this transaction. This property will be populated once this transaction is completed successfully.

Platforms:: iOS, Android, Windows

Adobe DPS - Library and Store SDK 2.32

Class adobeDPS-PreviewImageTransaction

Constructor

Fields

Methods