Class CXoneUser

Class to manage all user-related methods

Hierarchy

CXoneUser

Constructors

constructor

new CXoneUser(): CXoneUser

constructor for CXoneUser
example
```
const cxoneUser = CXoneUser.instance;
```
Returns CXoneUser

Properties

Private adminService

adminService: AdminService

Protected logger

logger: Logger = ...

userInfo

userInfo: UserInfo = ...

Private validationUtils

validationUtils: ValidationUtils = ...

Static cxoneUser

cxoneUser: CXoneUser

Accessors

Static instance

get instance(): CXoneUser

Method to create singleton object of the class
example
```
const user = CXoneUser.instance;
```
Returns CXoneUser

Methods

checkUserDigitalEngagement

checkUserDigitalEngagement(): Promise<boolean | CXoneSdkError>

method to check DigitalEngagement is enabled at user level
example
```
checkUserDigitalEngagement();
```
Returns Promise<boolean | CXoneSdkError>

getAgentSettings

getAgentSettings(): Promise<AgentSettings>

Method to return agent settings
example
```
this.getAgentSettings()
```
Returns Promise<AgentSettings>
- return the agent settings

getClientData

getClientData(): Promise<string | CXoneSdkError>

Method to return client data

Returns Promise<string | CXoneSdkError>
- returns the client data
```
@example
getClientData()
```

getDigitalSearchTabPermissions

getDigitalSearchTabPermissions(): CXoneDigitalSearchTabPermissions

Method to get digital interaction search tab permissions from local storage
example
```
cxoneUser.getDigitalSearchTabPermissions();
```
Returns CXoneDigitalSearchTabPermissions
- the interaction search tab permissions as permission object

getUserDetails

getUserDetails(): Promise<CXoneSdkError | UserInfo>

Get the current logged in user details

Returns Promise<CXoneSdkError | UserInfo>
- It returns the user information
```
@example
getUserDetails();
```

getUserInfo

getUserInfo(): UserInfo

Get the user details from the auth token that stored in the local storage
example
```
getUserInfo();
```
Returns UserInfo
- It returns the user information

getUserLocation

getUserLocation(): Promise<CXoneSdkError | UserLocation>

Method to get user location
example
```
getUserLocation();
```
Returns Promise<CXoneSdkError | UserLocation>
- It returns the user location

initAuth

initAuth(accessToken: string, cxOneConfig: CXoneConfiguration): void

Method to initialize auth details
example
```
const user = CXoneUser.instance;
user.initAuth(accessToken, cxOneConfig);
```
Parameters
- accessToken: string
  
  access token
- cxOneConfig: CXoneConfiguration
  
  CXoneConfig details
Returns void

isCustomAttributesEnabled

isCustomAttributesEnabled(attribute: UserCustomAttributes): Promise<boolean | CXoneSdkError>

method to check product app is enabled at user level
example
```
isCustomAttributesEnabled();
```
Parameters
- attribute: UserCustomAttributes
Returns Promise<boolean | CXoneSdkError>

setDigitalUserDetails

setDigitalUserDetails(userDetails: UserInfo): void

Set the userinfo like digital id, brand id after the successful authentication
example
```
setDigitalUserDetails(userDetails);
```
Parameters
- userDetails: UserInfo
  
  user info data
Returns void

setTeamIdUserInfo

setTeamIdUserInfo(teamId: number): void

Set the Team ID in User Info
example
```
setTeamIdUserInfo(teamId)
```
Parameters
- teamId: number
  
  Team ID
Returns void

setUserDetails

setUserDetails(verfiedUser: JwtPayload, isVerified: boolean): void

Set the userinfo from the idToken after the successful authentication
example
```
setUserDetails(authToken);
```
Parameters
- verfiedUser: JwtPayload
- isVerified: boolean
Returns void

setUserLocation

setUserLocation(locationId: string): Promise<HttpResponse | CXoneSdkError>

Method to set user location
example
```
setUserLocation(locationId);
```
Parameters
- locationId: string
  
  location id
Returns Promise<HttpResponse | CXoneSdkError>
- It returns the user location

Generated using TypeDoc