CXoneConfiguration | nice-cxone-acd-agent-apps

Model class for CXOne configuration

Hierarchy

CXoneConfiguration

Constructors

constructor

new CXoneConfiguration(): CXoneConfiguration

Returns CXoneConfiguration

Properties

aahNotificationWssUri

aahNotificationWssUri: string

remarks

agent assist notification websocket URI

aaiTranscriptWsUri

aaiTranscriptWsUri: string

remarks

AAI transcript websocket URI

acdApiBaseUri

acdApiBaseUri: string

remarks

CXOne API End point

acdDomain

acdDomain: string

remarks

ACD domain url

apiFacadeBaseUri

apiFacadeBaseUri: string

remarks

API facade Base URL used to invoke UH API

area

area: string

remarks

area

cluster

cluster: string

remarks

cluster

dfoApiBaseUri

dfoApiBaseUri: string

remarks

dfoAppBaseUri

dfoAppBaseUri: string

remarks

DFO APP based End point(2.0)

dfoWssUri

dfoWssUri: string

remarks

domain

domain: string

remarks

domain

globaldomain

globaldomain: string

remarks

global domain URI

grafanaFaroUri

grafanaFaroUri: string

remarks

grafana faro URI for log collection

isUserHub

isUserHub: boolean

remarks

UserHub is enable or not

notificationUri

notificationUri: string

remarks

presenceSyncApiUrl

presenceSyncApiUrl: string

remarks

PresenceSync(i.e)Directory 2.0 API end point

presenceSyncWebSocketUrl

presenceSyncWebSocketUrl: string

remarks

PresenceSync(i.e)Directory 2.0 WebSocket URL

uiQueueWSBaseUri

uiQueueWSBaseUri: string

remarks

UIQueue endpoint

userHubBaseUrl

userHubBaseUrl: string

remarks

userHubDomain

userHubDomain: string

remarks

User hub domain url

wfmUri

wfmUri: string

remarks

Methods

Private formWssUri

formWssUri(userHubArea: string, domain: string, wsQueryParams: WsRequestQueryParams): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:339
This method returns wss connection url with query params
example
```
formWssUri(userHubArea, domain, wsQueryParams);
```
Parameters
- userHubArea: string
  
  UserHub region
- domain: string
  
  root domain
- wsQueryParams: WsRequestQueryParams
  
  object containing tenant & user id
Returns string
- api end point

Private getAPIFacadeBaseUri

getAPIFacadeBaseUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:288
This method returns getAPIFacadeBaseUri

Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  apiFacadeDomain
```
@example
getAPIFacadeBaseUri('na1','staging.niceincontact.com');
```
Returns string
- api end point

Private getAahNotificationWssUri

getAahNotificationWssUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:208
This method returns the agent assist notification WS url
example
```
getAahNotificationWssUri('na1','staging.niceincontact.com');
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  domain
Returns string
- api end point

Private getAaiTranscriptWsUri

getAaiTranscriptWsUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:366
This method returns the agent assist transcript WS uri
example
```
getAaiTranscriptWsUri('na1','staging.niceincontact.com');
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  domain
Returns string
- api end point

Private getDfoApiBaseUri

getDfoApiBaseUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:252
This method returns DfoApiBaseUri
example
```
dfoApiBaseUri = "https://api-de-{area}.{domain}/"
getDfoApiBaseUri('na1','staging.niceincontact.com');
getDfoApiBaseUri('na2','nicecxone-gov.com');
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  apiFacadeDomain
Returns string
- api end point

Private getDfoAppBaseUri

getDfoAppBaseUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:303
This method returns DFO APP baseURI version 2.0, need to replace by latest 3.0 API once available from DFO,

Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  apiFacadeDomain
```
@example
getDfoAppBaseUri('na1','staging.niceincontact.com');
```
Returns string
- api end point

Private getDfoWssUri

getDfoWssUri(userHubArea: string, domain: string, wsQueryParams: WsRequestQueryParams): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:270
This method returns Dfo Websocket Uri
example
```
dfoWssUri = "https://api-de-{area}.{domain}/"
getDfoWssUri('na1','staging.niceincontact.com');
getDfoWssUri('na2','niceincontact.com'); For FedRamp
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  apiFacadeDomain
- wsQueryParams: WsRequestQueryParams
Returns string
- api end point

Private getFedRampBaseUri

getFedRampBaseUri(userHubArea: string, isWebSocket: boolean, wsQueryParams?: WsRequestQueryParams): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:319
This method returns DfoApiBaseUri for FedRamp domains
example
```
getFedRampBaseUri('na2', true);
```
Parameters
- userHubArea: string
  
  UserHub region
- isWebSocket: boolean
  
  flag for websocket detection
- Optional wsQueryParams: WsRequestQueryParams
Returns string
- api end point

Private getGrafanaFaroUri

getGrafanaFaroUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:380
This method returns the grafana faro uri
example
```
getGrafanaFaroUri('na1','nicecxone-dev.com');
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  domain
Returns string
- api end point

Private getPresenceSyncUri

getPresenceSyncUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:180
This method returns the Presence sync url
example
```
getPresenceSyncUri('na1','staging.niceincontact.com');
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  domain
Returns string
- api end point

Private getPresenceSyncWSUri

getPresenceSyncWSUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:194
This method returns the Presence sync WS url
example
```
getPresenceSyncWSUri('na1','staging.niceincontact.com');
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  domain
Returns string
- api end point

Private getUIQueueWSBaseUri

getUIQueueWSBaseUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:352
This method returns getUIQueueWSBaseUri

Parameters
- userHubArea: string
- domain: string
Returns string
- api end point
```
@example
getUIQueueWSBaseUri('na2', 'staging.niceincontact.com', 'du01');
```

Private getUserHubNotificationUri

getUserHubNotificationUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:236
This method returns the notification_uri
example
```
getUserHubNotificationUri('na1','staging.nice-incontact.com');
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  domain
Returns string
- api end point

Private getUserHubWfmUri

getUserHubWfmUri(userHubArea: string, domain: string): string

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:222
This method returns the wfm_uri
example
```
getUserHubWfmUri('na1','staging.nice-incontact.com');
```
Parameters
- userHubArea: string
  
  userHubArea
- domain: string
  
  domain
Returns string
- api end point

parseData

parseData(data: {}): void

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:106
This method to parse CXoneConfiguration data

Parameters
- data: {}
  CXoneConfiguration API response
```
@example
const config = new CXoneConfiguration();
config.parseData(data);
```
  - [key: string]: string
Returns void

setAuthEndPoints

setAuthEndPoints(isUserHub: boolean, wsQueryParams: WsRequestQueryParams): void

- Defined in common-sdk/src/lib/model/authenticate/cxone-configuration.ts:124
This method is to set the endpoints for user hub and central systems
example
```
setAuthEndPoints(isUserHub);
```
Parameters
- isUserHub: boolean
  
  It would be false if it were the central user.
- wsQueryParams: WsRequestQueryParams
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CXoneConfiguration

Properties

aahNotificationWssUri

aaiTranscriptWsUri

acdApiBaseUri

acdDomain

apiFacadeBaseUri

area

cluster

dfoApiBaseUri

dfoAppBaseUri

dfoWssUri

domain

globaldomain

grafanaFaroUri

isUserHub

notificationUri

presenceSyncApiUrl

presenceSyncWebSocketUrl

uiQueueWSBaseUri

userHubBaseUrl

userHubDomain

wfmUri

Methods

Private formWssUri

Parameters

userHubArea: string

domain: string

wsQueryParams: WsRequestQueryParams

Returns string

Private getAPIFacadeBaseUri

Parameters

userHubArea: string

domain: string

Returns string

Private getAahNotificationWssUri

Parameters

userHubArea: string

domain: string

Returns string

Private getAaiTranscriptWsUri

Parameters

userHubArea: string

domain: string

Returns string

Private getDfoApiBaseUri

Parameters

userHubArea: string

domain: string

Returns string

Private getDfoAppBaseUri

Parameters

userHubArea: string

domain: string

Returns string

Private getDfoWssUri

Parameters

userHubArea: string

domain: string

wsQueryParams: WsRequestQueryParams

Returns string

Private getFedRampBaseUri

Parameters

userHubArea: string

isWebSocket: boolean

Optional wsQueryParams: WsRequestQueryParams

Returns string

Private getGrafanaFaroUri

Parameters

userHubArea: string

domain: string

Returns string

Private getPresenceSyncUri