Class adobeDPS-AuthenticationService
- Extends:
- adobeDPS-AuthenticationService -> adobeDPS-Service -> adobeDPS-Class
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
Service for sending custom analytics events.
Accessible from adobeDPS.authenticationService
Constructor
[inner]
Create an instance of the AuthenticationService.
Static Fields
| Field | Defined By | |
|---|---|---|
|
adobeDPS-AuthenticationService.instance
The singleton of the AuthenticationService.
|
AuthenticationService
|
Fields
| Field | Defined By | |
|---|---|---|
|
Signal to indicate updates to the AuthenticationService.
|
AuthenticationService
|
|
|
Signal to indicate that the user's authentication state has changed.
|
AuthenticationService
|
|
|
The current authentication transaction, if applicable.
|
AuthenticationService
|
|
|
isUserAuthenticated
: Boolean
Whether a user is currently authenticated.
|
AuthenticationService
|
|
|
userName
: String
The username of that user.
|
AuthenticationService
|
|
|
token
: String
If a user is authenticated, the token for this session.
|
AuthenticationService
|
Methods
| Method | Defined By | |
|---|---|---|
|
login(username:String, password:String, token:String)
Start a login transaction on this Folio.
|
AuthenticationService
|
|
|
logout()
Start a logout transaction on this Folio.
|
AuthenticationService
|
|
|
Ask the authentication service to present the native sign in UI.
|
AuthenticationService
|
|
|
toString()
Gets the string representation of this instance.
|
Class Detail
adobeDPS-AuthenticationService()
[inner]
Create an instance of the AuthenticationService.
- This is an internal constructor and shouldn't be called by regular users.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-AuthenticationService.instance
The singleton of the AuthenticationService.
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
Field Details
updatedSignal
: adobeDPS-Signal
Signal to indicate updates to the AuthenticationService.
Updates about isUserAuthenticated,
userName, and token are signaled.
Callback Signature: updatedHandler([String, ...])
Callback Signature: updatedHandler([String, ...])
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
userAuthenticationChangedSignal
: adobeDPS-Signal
Signal to indicate that the user's authentication state has changed.
Callback Signature: userAuthenticationChangedHandler(Boolean)
Callback Signature: userAuthenticationChangedHandler(Boolean)
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
currentTransaction
: adobeDPS-Transaction
The current authentication transaction, if applicable.
- See:
- adobeDPS-UserSigninTransaction
- adobeDPS-UserSignoutTransaction
- Platforms:
- iOS, Android (Library API Only)
isUserAuthenticated
: Boolean
Whether a user is currently authenticated.
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
userName
: String
The username of that user. Will be
null if isUserAuthenticated is false.
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
token
: String
If a user is authenticated, the token for this session.
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
Method Details
Start a login transaction on this Folio. Requires that
isUserAuthenticated be false.
| Parameters | ||
|---|---|---|
| username | String | The username of the user to sign-in (null if token is provided) |
| password | String | The password of the user to sign-in (null if token is provided) |
| token | String | The token of the user to sign-in |
- Throws:
- Error If a user is already authenticated or a username/password combination or token wasn't provided
- Returns:
- adobeDPS-UserSigninTransaction The started sign-in transaction
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
Start a logout transaction on this Folio. Requires that
isUserAuthenticated be true.
- Throws:
- Error If a user is not authenticated
- Returns:
- adobeDPS-UserSignoutTransaction The started sign-out transaction
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
displaySignIn()
Ask the authentication service to present the native sign in UI.
If currently authenticating or already signed in, UI is not shown.
- Platforms:
- iOS, Android (Library API Only), Windows (Library API Only)
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:25 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:25 GMT-0700 (PDT)