Class adobeDPS-AuthenticationService

Extends:: adobeDPS-AuthenticationService -> adobeDPS-Service -> adobeDPS-Class

Service for sending custom analytics events.
Accessible from adobeDPS.authenticationService

Constructor

adobeDPS-AuthenticationService()

[inner] Create an instance of the AuthenticationService.

	Field	Defined By
	adobeDPS-AuthenticationService.instance The singleton of the AuthenticationService.	AuthenticationService

	Field	Defined By
	userAuthenticationChangedSignal : adobeDPS-Signal Signal to indicate that the user's authentication state has changed.	AuthenticationService
	currentTransaction : adobeDPS-Transaction 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

	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
	toString() Gets the string representation of this instance.	Class

Class Detail

adobeDPS-AuthenticationService()

[inner] Create an instance of the AuthenticationService.
- This is an internal constructor and shouldn't be called by regular users.

Static Field Details

adobeDPS-AuthenticationService.instance

The singleton of the AuthenticationService.

Field Details

userAuthenticationChangedSignal : adobeDPS-Signal

Signal to indicate that the user's authentication state has changed.
Callback Signature: userAuthenticationChangedHandler(Boolean)

currentTransaction : adobeDPS-Transaction

The current authentication transaction, if applicable.

isUserAuthenticated : Boolean

Whether a user is currently authenticated.

userName : String

The username of that user. Will be null if isUserAuthenticated is false.

token : String

If a user is authenticated, the token for this session.

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

Start a logout transaction on this Folio. Requires that isUserAuthenticated be true.