Class adobeDPS-FolioTransaction
- Extends:
- adobeDPS-FolioTransaction -> adobeDPS-Transaction -> adobeDPS-Class
- Platforms:
- iOS, Android, Windows
Transaction associated with a BaseFolio
Constructor
[inner]
Create a FolioTransaction
Fields
Field | Defined By | |
---|---|---|
The BaseFolio that this transaction is acting on
|
FolioTransaction
|
|
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.
|
FolioTransaction
|
|
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-FolioTransaction(folio:adobeDPS-BaseFolio)
[inner]
Create a FolioTransaction
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
folio
: adobeDPS-BaseFolio
The BaseFolio that this transaction is acting on
- Platforms:
- iOS, Android, Windows
Method Details
Start a folio transaction. This will also result in this transaction being added to
the currentTransactions array of the BaseFolio associated with this transaction.
- Throws:
- Error If called when folio is in the wrong state
- Returns:
- adobeDPS-FolioTransaction The started transaction
- Platforms:
- iOS, Android, Windows
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:26 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:26 GMT-0700 (PDT)