Class CXoneAgentSetting

Class to manage agent setting

Hierarchy

CXoneAgentSetting

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CXoneAgentSetting(): CXoneAgentSetting

- Defined in agent-sdk/src/lib/acd/cxone-agent-setting/cxone-agent-setting.ts:20
get instance for CXoneAgentSetting and adminService
example
```
const cxoneAgentSetting = new CXoneAgentSetting();
```
Returns CXoneAgentSetting

Properties

Private acdSessionManager

acdSessionManager: ACDSessionManager = ...

Private adminService

adminService: AdminService

Private logger

logger: Logger = ...

mchAgentSettingsChangeEvent

mchAgentSettingsChangeEvent: Subject<MCHSetting> = ...

Methods

clearNotificationSettings

clearNotificationSettings(): Promise<void>

- Defined in agent-sdk/src/lib/acd/cxone-agent-setting/cxone-agent-setting.ts:131
Method to clear Notification Settings
example
```
clearNotificationSettings()
```
Returns Promise<void>

getAgentClientDataSettings

getAgentClientDataSettings(): Promise<CXoneSdkError | CXoneClientData>

- Defined in agent-sdk/src/lib/acd/cxone-agent-setting/cxone-agent-setting.ts:47
To get client data and extract AVNotifications and soft phone settings
example
```
getAgentClientDataSettings();
```
Returns Promise<CXoneSdkError | CXoneClientData>

getAgentSettings

getAgentSettings(): Promise<CXoneSdkError | AgentSettings>

- Defined in agent-sdk/src/lib/acd/cxone-agent-setting/cxone-agent-setting.ts:34
Method to return agent settings

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

getNotificationSettings

getNotificationSettings(): Promise<CXoneAudioVisualNotificationSettings>

- Defined in agent-sdk/src/lib/acd/cxone-agent-setting/cxone-agent-setting.ts:107
Method to get fav quick Replies
example
- getNotificationSettings()
Returns Promise<CXoneAudioVisualNotificationSettings>

Private onMCHAgentSettingsChange

onMCHAgentSettingsChange(): void

- Defined in agent-sdk/src/lib/acd/cxone-agent-setting/cxone-agent-setting.ts:93
Method to subscribe multi-channel agent settings

Returns void

setNotificationSettings

setNotificationSettings(clientData: CXoneAudioVisualNotificationSettings): Promise<void>

- Defined in agent-sdk/src/lib/acd/cxone-agent-setting/cxone-agent-setting.ts:119
Method to set notification settings
example
Parameters
- clientData: CXoneAudioVisualNotificationSettings
Returns Promise<void>

updateAgentClientDataSettings

updateAgentClientDataSettings(updatedData: CXoneClientData): Promise<string | CXoneSdkError>

- Defined in agent-sdk/src/lib/acd/cxone-agent-setting/cxone-agent-setting.ts:77
To update AVNotifications and softphone settings
example
```
updateAgentClientDataSettings();
```
Parameters
- updatedData: CXoneClientData
  
  updated data received from consumer
Returns Promise<string | CXoneSdkError>

Generated using TypeDoc