Adobe DPS - JavaScript Library API

Class adobeDPS-DownloadTransaction

Extends:
adobeDPS-DownloadTransaction -> adobeDPS-FolioStateChangingTransaction -> adobeDPS-FolioTransaction -> adobeDPS-Transaction -> adobeDPS-Class

A Transaction that is used to download a Folio.

Constructor

adobeDPS-DownloadTransaction(folio:adobeDPS-Folio)
[inner] Create a Download Transaction

Fields

Field Defined By
step : Integer
The current step of the download that is taking place.
DownloadTransaction
Inherited from adobeDPS-FolioTransaction
The Folio 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-FolioStateChangingTransaction
start()
Start a folio transaction.
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-DownloadTransaction(folio:adobeDPS-Folio)
[inner] Create a Download Transaction
Parameters
folio adobeDPS-Folio The folio that this transaction is acting on
Throws:
{Error} If the folio passed in is invalid or not a Folio
Field Details
step : Integer
The current step of the download that is taking place. The step is represented by an integer. Depending on the platform and the content that is being downloaded, you may never see certain steps. The following are possible step values: 0 - Initialized 1 - Downloading 2 - Installing
©2012 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 01 2012 12:15:45 GMT-0700 (PDT)