Class AdminService

Class to perform get admin api

Hierarchy

AdminService

Constructors

constructor

new AdminService(): AdminService

Returns AdminService

Properties

Private accessToken

accessToken: string = ''

Private agentIndicatorsInfo

agentIndicatorsInfo: CXoneIndicator[] = []

Private apiParser

apiParser: ApiParser = ...

Private cxOneConfig

cxOneConfig: CXoneConfiguration = ...

Protected logger

logger: Logger = ...

Private userInfo

userInfo: UserInfo = ...

Protected utilService

utilService: HttpUtilService = ...

Private validationUtils

validationUtils: ValidationUtils = ...

Static Private singleton

singleton: AdminService

Accessors

Static instance

get instance(): AdminService

Method to create singleton object of the class
```
@example
const agentSession = AdminService.instance;
```
Returns AdminService

Methods

getAgentSettings

getAgentSettings(): Promise<AgentSettings>

Method to return agent settings

Returns Promise<AgentSettings>
- return the agent settings
```
@example
getAgentSettings()
```

getAllIndicators

getAllIndicators(): Promise<CXoneIndicator[]>

Method to return all indicators

Returns Promise<CXoneIndicator[]>
- returns all indicators
```
@example
getAllIndicators()
```

getBrandingProfile

getBrandingProfile(): Promise<CXoneSdkError | BrandingProfile>

Method to return cxone branding profiles

Returns Promise<CXoneSdkError | BrandingProfile>
- returns the cxone branding profiles
```
@example
getBrandingProfile()
```

getBusinessUnit

getBusinessUnit(): Promise<CXoneSdkError | BusinessUnit>

Method to return business unit features

Returns Promise<CXoneSdkError | BusinessUnit>
- returns the business unit features
```
@example
getBusinessUnit()
```

getCXoneConfig

getCXoneConfig(): CXoneConfiguration

example
```
const cxoneConfig = this.getCXoneConfig();
```
Returns CXoneConfiguration
- cxone configuration object

getCentralBrandingProfile

getCentralBrandingProfile(): Promise<CXoneSdkError | CentralBrandingProfile>

Method to return central branding profile

Returns Promise<CXoneSdkError | CentralBrandingProfile>
- returns the central branding profile
```
@example
getCentralBrandingProfile()
```

getClientData

getClientData(): Promise<string | CXoneSdkError>

Method to return client data

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

getPermissions

getPermissions(forceFetch?: boolean): Promise<CXoneSdkError | Permissions[]>

Method to return agent permissions

Parameters
- forceFetch: boolean = false
Returns Promise<CXoneSdkError | Permissions[]>
- return the agent permissions
```
@example
getPermissions()
```

getScriptByName

getScriptByName(scriptName: string): Promise<number>

Method to call the script to get the skill Id
example
```
getScriptData('scriptName');
```
Parameters
- scriptName: string
Returns Promise<number>

getTimeStampOffset

getTimeStampOffset(): Promise<number | CXoneSdkError>

Method to get time stamp offset

Returns Promise<number | CXoneSdkError>
- number or CXoneSdkError
```
@example
getTimeStampOffset()
```

getUHUserDetails

getUHUserDetails(): Promise<HttpResponse | CXoneSdkError>

Method to return User Hub user details

Returns Promise<HttpResponse | CXoneSdkError>
- User Details
```
@example
getUHUserDetails()
```

getUiqHubUrl

getUiqHubUrl(): Promise<HttpResponse | CXoneSdkError>

Method to return aggregator service node url for uiq connection

Returns Promise<HttpResponse | CXoneSdkError>
- User Details
```
@example
getUiqHubUrl()
```

getUserDetails

getUserDetails(useCache?: boolean): Promise<CXoneUserDetails>

Fetches the details of loged in user

Parameters
- useCache: boolean = false
  True to use cached data if available
```
@example
getUserDetails(true)
```
Returns Promise<CXoneUserDetails>
Details of the User

getUserLocations

getUserLocations(): Promise<CXoneSdkError | UserLocation>

Method to return agent locations
example
```
getUserLocations()
```
Returns Promise<CXoneSdkError | UserLocation>
- User Details

initialize

initialize(accessToken: string, config: CXoneConfiguration, userInfo: UserInfo): void

Method to initialize the user details (i.e) cxoneConfig, userInfo and aceessToken
example
```
const agentSession = AdminService.instance.initialize(accessToken, config, userInfo);
```
Parameters
- accessToken: string
  
  Access token
- config: CXoneConfiguration
  
  cxoneConfig object
- userInfo: UserInfo
  
  user info object
Returns void

putClientData

putClientData(clientData: {}): Promise<string | CXoneSdkError>

Method to return client data

Parameters
- clientData: {}
  - [key: string]: any
Returns Promise<string | CXoneSdkError>
- returns the client data
```
@example
getClientData()
```

resizeEventQueue

resizeEventQueue(sessionId: string, throttle: boolean): Promise<void>

Method to resize the event queue
example
```
resizeEventQueue('12345',true)
```
Parameters
- sessionId: string
  
  session id
- throttle: boolean
  
  boolean value to throttle the event queue size
Returns Promise<void>
- Promise that resolves when the event queue is resized

selectUserLocation

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

Method to select agent location
example
```
selectUserLocation('123')
```
Parameters
- locationId: string
  
  location id
Returns Promise<HttpResponse | CXoneSdkError>
- User Details

setAccessToken

setAccessToken(accessToken: string): void

example
```
this.setAccessToken(accessToken);
```
Parameters
- accessToken: string
  
  access token
Returns void

setTimeStampOffset

setTimeStampOffset(): Promise<number>

Method to set the server time offset in local storage
example
- setTimeStampOffset()
Returns Promise<number>

signalScript

signalScript(contactId: string, parameters: any): Promise<HttpResponse | CXoneSdkError>

Method to start the signal script
example
```
signalScript('123', {});
```
Parameters
- contactId: string
  
  contact id
- parameters: any
Returns Promise<HttpResponse | CXoneSdkError>

spawnScript

spawnScript(scriptId: number, skillId: number, parameters: string, startDate: string): Promise<HttpResponse | CXoneSdkError>

Method to call spawn script
example
```
spawnScript();
```
Parameters
- scriptId: number
- skillId: number
- parameters: string
- startDate: string
Returns Promise<HttpResponse | CXoneSdkError>

Generated using TypeDoc