Class adobeDPS-UserSigninTransaction

Extends:: adobeDPS-UserSigninTransaction -> adobeDPS-Transaction -> adobeDPS-Class
Platforms:: iOS, Android, Windows

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.

	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
	stateChangedSignal : adobeDPS-Signal Signal to indicate that the state of this transaction has changed.	Transaction
	completedSignal : adobeDPS-Signal Signal to indicate that the transaction has completed.	Transaction
	progressSignal : adobeDPS-Signal Signal to indicate transaction progress.	Transaction
	id : String The Unique id of this Transaction.	Transaction
	state : adobeDPS-TransactionState The state of this Transaction.	Transaction
	progress : Number The progress of this Transaction.	Transaction
	error : adobeDPS-TransactionError The TransactionError associated with this transaction, assuming an error has occurred.	Transaction
	isCancelable : Boolean = false Whether this Transaction can be canceled.	Transaction
	isPausable : Boolean = false Whether this Transaction can be paused.	Transaction
	isDeterminate : Boolean = false Whether this Transaction is determinate (has progress).	Transaction
	isFailureTerminal : Boolean = false Whether failure of the transaction is a terminal state.	Transaction

	Method	Defined By
	isFolioStateChangingTransaction() Whether this transaction is of type FolioStateChangingTransaction	Transaction
	start() Start this transaction.	Transaction
	pause() Pauses a transaction.	Transaction
	resume() Resumes a paused transaction.	Transaction
	cancel() Cancels a transaction.	Transaction
	toString() Gets the string representation of this instance.	Class

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.

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.