Class CXoneDigitalClient

This is the base class for Digital

Hierarchy

CXoneDigitalClient

Constructors

constructor

new CXoneDigitalClient(): CXoneDigitalClient

- Defined in digital-sdk/src/lib/cxone-digital-client.ts:35
get instance for agent auth and session
example
```
const cxoneDigitalClient = new CXoneDigitalClient();
```
Returns CXoneDigitalClient

Properties

auth

auth: CXoneAuth = ...

cxoneDigitalWebsocket

cxoneDigitalWebsocket: CXoneDigitalWebsocket = ...

cxoneTenant

cxoneTenant: CXoneTenant = ...

cxoneUser

cxoneUser: CXoneUser = ...

digitalContactManager

digitalContactManager: DigitalContactManager = ...

digitalEventFactory

digitalEventFactory: DigitalEventFactory = ...

digitalMessageNoteService

digitalMessageNoteService: DigitalMessageNoteService = ...

digitalService

digitalService: DigitalService = ...

Private isStartedDigitalStatusPolling

isStartedDigitalStatusPolling: boolean = false

Private logger

logger: Logger = ...

skillService

skillService: SkillService = ...

Static Private singleton

singleton: CXoneDigitalClient

Accessors

Static instance

get instance(): CXoneDigitalClient

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

Methods

clearDigitalCache

clearDigitalCache(): Promise<void>

- Defined in digital-sdk/src/lib/cxone-digital-client.ts:171
Method to clear local and session storage
example
```
clearDigitalCache()
```
Returns Promise<void>

Private getDigitalUserDetails

getDigitalUserDetails(): Promise<void>

- Defined in digital-sdk/src/lib/cxone-digital-client.ts:153
Get digital logged in user details like UserId to call other digital APIs
example
```
getDigitalUserDetails();
```
Returns Promise<void>

initDigitalEngagement

initDigitalEngagement(): Promise<void>

- Defined in digital-sdk/src/lib/cxone-digital-client.ts:65
method to initialize DigitalEngagement
example
```
initDigitalEngagement();
```
Returns Promise<void>

Private onLeaderElectionChange

onLeaderElectionChange(): void

- Defined in digital-sdk/src/lib/cxone-digital-client.ts:186
Subscription for leader change event

Returns void

Private setDigitalWebSocketUri

setDigitalWebSocketUri(): Promise<void>

- Defined in digital-sdk/src/lib/cxone-digital-client.ts:261
Method to fetch DFO Websocket URL from DX API & set in CXone config
example
```
setDigitalWebSocketUri()
```
Returns Promise<void>

Private subscribePollingResponseMessage

subscribePollingResponseMessage(): void

- Defined in digital-sdk/src/lib/cxone-digital-client.ts:130
Method to subscribe message bus polling response message
example
```
 subscribePollingResponseMessage()
```
Returns void

Private updateDfoApiUrl

updateDfoApiUrl(): void

- Defined in digital-sdk/src/lib/cxone-digital-client.ts:240
Method to update DFO API URL
example
```
updateDfoApiUrl()
```
Returns void

Generated using TypeDoc