Adobe DPS - Library and Store SDK 2.32

Class adobeDPS-ArchiveTransaction

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

Transaction used to archive a BaseFolio

Constructor

adobeDPS-ArchiveTransaction(folio:adobeDPS-BaseFolio)
[inner] Create an ArchiveTransaction

Fields

Field Defined By
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-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-ArchiveTransaction(folio:adobeDPS-BaseFolio)
[inner] Create an ArchiveTransaction
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
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:25 GMT-0700 (PDT)