Skip to content
This repository has been archived by the owner on Jul 27, 2019. It is now read-only.

Latest commit

 

History

History
104 lines (74 loc) · 3.24 KB

File metadata and controls

104 lines (74 loc) · 3.24 KB

Members

CSDKUserAuth

A global object that lets you log users in and out with their Adobe ID.

Typedefs

loginSuccessCallback : function

Called if the user login was successful.

logoutSuccessCallback : function

Called if the user logout was successful. No arguments are returned.

failureCallback : function

Called if the user login or logout fails.

UserObject : Object

A JSON object containing user data.

CSDKUserAuth

A global object that lets you log users in and out with their Adobe ID.

Kind: global variable

CSDKUserAuth.login(loginSuccessCallback, failureCallback)

Launches the User Auth UI component so a user can log in with their Adobe ID.

Kind: static method of CSDKUserAuth

Param Type Description
loginSuccessCallback loginSuccessCallback See type definition.
failureCallback failureCallback See type definition.

CSDKUserAuth.logout(logoutSuccessCallback, failureCallback)

Logs the user out of their Adobe ID.

Kind: static method of CSDKUserAuth

Param Type Description
logoutSuccessCallback logoutSuccessCallback See type definition.
failureCallback failureCallback See type definition.

loginSuccessCallback : function

Called if the user login was successful.

Kind: global typedef

Param Type Description
userObject UserObject See type definition.

logoutSuccessCallback : function

Called if the user logout was successful. No arguments are returned.

Kind: global typedef

failureCallback : function

Called if the user login or logout fails.

Kind: global typedef

Param Type Description
error string Error message.

UserObject : Object

A JSON object containing user data.

Kind: global typedef
Properties

Name Type Description
adobeID string The Adobe ID of the user.
displayName string The display name of the user.
firstName string The first name of the user.
lastName string The last name of the user.
email string The email address of the user.