Adobe DPS - JavaScript Library API

Class adobeDPS-PreviewImageTransaction

Extends:
adobeDPS-PreviewImageTransaction -> adobeDPS-FolioTransaction -> adobeDPS-Transaction -> adobeDPS-Class

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
Inherited from adobeDPS-FolioTransaction
The BaseFolio that this transaction is acting on
Inherited from adobeDPS-Transaction
Signal to indicate that the state of this transaction has changed.
Inherited from adobeDPS-Transaction
Signal to indicate that the transaction has completed.
Inherited from adobeDPS-Transaction
Signal to indicate transaction progress.
Inherited from adobeDPS-Transaction
id : String
The Unique id of this Transaction.
Inherited from adobeDPS-Transaction
The state of this Transaction.
Inherited from adobeDPS-Transaction
progress : Number
The progress of this Transaction.
Inherited from adobeDPS-Transaction
The TransactionError associated with this transaction, assuming an error has occurred.
Inherited from adobeDPS-Transaction
isCancelable : Boolean = false
Whether this Transaction can be canceled.
Inherited from adobeDPS-Transaction
isPausable : Boolean = false
Whether this Transaction can be paused.
Inherited from adobeDPS-Transaction
isDeterminate : Boolean = false
Whether this Transaction is determinate (has progress).
Inherited from adobeDPS-Transaction
isFailureTerminal : Boolean = false
Whether failure of the transaction is a terminal state.

Methods

Method Defined By
Inherited from adobeDPS-FolioTransaction
start()
Start a folio transaction.
Inherited from adobeDPS-Transaction
Whether this transaction is of type FolioStateChangingTransaction
Inherited from adobeDPS-Transaction
start()
Start this transaction.
Inherited from adobeDPS-Transaction
pause()
Pauses a transaction.
Inherited from adobeDPS-Transaction
resume()
Resumes a paused transaction.
Inherited from adobeDPS-Transaction
cancel()
Cancels a transaction.
Inherited from adobeDPS-Class
Gets the string representation of this instance.
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.
width : Number
The requested width of the preview image.
height : Number
The requested height of the preview image.
previewImageURL : String
The resulting image URL of this transaction. This property will be populated once this transaction is completed successfully.
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 01 2013 13:18:39 GMT-0800 (PST)