Adobe DPS - Library and Store SDK 2.27

Class adobeDPS-UserSigninTransaction

Extends:
adobeDPS-UserSigninTransaction -> adobeDPS-Transaction -> adobeDPS-Class

A Transaction that is used to sign-in a user.

Constructor

adobeDPS-UserSigninTransaction(username:String, password:String, token:String)
[inner] Create a User Sign-in Transaction.

Fields

Field Defined By
username : String
The username to use to login.
UserSigninTransaction
password : String
The password to use to login.
UserSigninTransaction
token : String
The token to use to login.
UserSigninTransaction
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-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-UserSigninTransaction(username:String, password:String, token:String)
[inner] Create a User Sign-in Transaction. You must either pass in both a username and password or a token in order to sign-in.
Parameters
username String The username to use to login
password String The password to use to login
token String The token to use to login
Throws:
{Error} If a token or a username/password combination is not provided
Field Details
username : String
The username to use to login.
password : String
The password to use to login.
token : String
The token to use to login.
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jun 24 2013 16:54:21 GMT-0700 (PDT)