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.
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
|
|
![]() |
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 | |
---|---|---|
![]() |
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-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.
- Platforms:
- iOS, Android, Windows
password
: String
The password to use to login.
- Platforms:
- iOS, Android, Windows
token
: String
The token to use to login.
- Platforms:
- iOS, Android, Windows
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:41 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:41 GMT-0700 (PDT)