Class adobeDPS-DownloadTransaction
- Extends:
- adobeDPS-DownloadTransaction -> adobeDPS-FolioStateChangingTransaction -> adobeDPS-FolioTransaction -> adobeDPS-Transaction -> adobeDPS-Class
- Platforms:
- iOS, Android, Windows
A Transaction that is used to download a BaseFolio.
Constructor
[inner]
Create a Download Transaction
Fields
Field | Defined By | |
---|---|---|
step
: Integer
The current step of the download that is taking place.
|
DownloadTransaction
|
|
The BaseFolio that this transaction is acting on
|
||
Signal to indicate that the state of this transaction has changed.
|
||
Signal to indicate that the transaction has completed.
|
||
Signal to indicate transaction progress.
|
||
id
: String
The Unique id of this Transaction.
|
||
The state of this Transaction.
|
||
progress
: Number
The progress of this Transaction.
|
||
The TransactionError associated with this transaction, assuming an error has occurred.
|
||
isCancelable
: Boolean = false
Whether this Transaction can be canceled.
|
||
isPausable
: Boolean = false
Whether this Transaction can be paused.
|
||
isDeterminate
: Boolean = false
Whether this Transaction is determinate (has progress).
|
||
isFailureTerminal
: Boolean = false
Whether failure of the transaction is a terminal state.
|
Methods
Method | Defined By | |
---|---|---|
start()
Start a folio transaction.
|
||
start()
Start a folio transaction.
|
||
Whether this transaction is of type FolioStateChangingTransaction
|
||
start()
Start this transaction.
|
||
pause()
Pauses a transaction.
|
||
resume()
Resumes a paused transaction.
|
||
cancel()
Cancels a transaction.
|
||
toString()
Gets the string representation of this instance.
|
Class Detail
adobeDPS-DownloadTransaction(folio:adobeDPS-BaseFolio)
[inner]
Create a Download Transaction
Parameters | ||
---|---|---|
folio | adobeDPS-BaseFolio | The folio that this transaction is acting on |
- Throws:
- {Error} If the folio passed in is invalid or not a BaseFolio
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
- Platforms:
- iOS, Android
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)