Class CXoneAcdClient

This is the base class for ACD

Hierarchy

CXoneAcdClient

Constructors

constructor

new CXoneAcdClient(): CXoneAcdClient

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:37
get instance for agent auth and session
```
@example
const cxoneAcdClient = new CXoneAcdClient();
```
Returns CXoneAcdClient

Properties

agentDetailService

agentDetailService: AgentDetailService = ...

agentLegService

agentLegService: AgentLegService = ...

agentListService

agentListService: AttendantAgentListService = ...

agentStateService

agentStateService: AgentStateService = ...

contactManager

contactManager: ContactManager = ...

indicator

indicator: CXoneIndicatorManager = ...

Private logger

logger: Logger = ...

notification

notification: CXoneNotificationManager = ...

screenPop

screenPop: CXoneScreenPop = ...

session

session: CXoneSession = ...

Private skillService

skillService: SkillService = ...

Static Private singleton

singleton: CXoneAcdClient

Accessors

Static instance

get instance(): CXoneAcdClient

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:51
Method to create singleton object of the class
```
@example
const cxoneAcdClient = CXoneAcdClient.instance();
```
Returns CXoneAcdClient

Methods

getAgentSkills

getAgentSkills(agentId?: string): Promise<AgentSkill[]>

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:165
Method to get agent skills
example
```
getAgentSkills('1001') || getAgentSkills()
```
Parameters
- Optional agentId: string
  
  nullable Agent Id
Returns Promise<AgentSkill[]>
- agent skills details as an AgentSkill[]

getCachedAgentSkills

getCachedAgentSkills(agentId?: string): AgentSkill[] | Promise<AgentSkill[]>

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:178
Method to get cached agent skills
example
```
getCachedAgentSkills('1001') || getCachedAgentSkills()
```
Parameters
- Optional agentId: string
  
  nullable Agent Id
Returns AgentSkill[] | Promise<AgentSkill[]>
- cached agent skills details as an AgentSkill[]

getTeamUnavailableCodes

getTeamUnavailableCodes(teamId?: string): Promise<CXoneSdkError | UnavailableCode[]>

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:150
method to return Team Unavailable Codes

Parameters
- Optional teamId: string
  
  TeamId
Returns Promise<CXoneSdkError | UnavailableCode[]>
- Team Unavailable Codes
```
@example
getTeamUnavailableCodes();
```

initAcdEngagement

initAcdEngagement(): Promise<void>

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:65
method to initialize ACDEngagement
```
@example
initAcdEngagement();
```
Returns Promise<void>

setClickToDialCustomAgentUrl

setClickToDialCustomAgentUrl(customAgentUrl: string): void

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:210
Set the custom agent URL for the Click to Dial extension
example
```
setClickToDialCustomAgentUrl('https://custom-agent-url.com');
```
Parameters
- customAgentUrl: string
  
  The custom agent URL to be updated
Returns void

Private subscribeRequestMessage

subscribeRequestMessage(): void

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:86
Subscription for request message over broadcast channel

Returns void

Private subscribeResponseMessage

subscribeResponseMessage(): void

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:118
Subscription for response message over broadcast channel

Returns void

Private updateUIQInstanceManagerURL

updateUIQInstanceManagerURL(): void

- Defined in acd-sdk/src/lib/cxone-acd-client.ts:189
Method to update the UIQ instance manager URL
example
```
updateUIQInstanceManagerURL();
```
Returns void

Generated using TypeDoc