CXoneDirectory | nice-cxone-acd-agent-apps

This is the base class for Directory

Hierarchy

CXoneDirectory

Constructors

constructor

new CXoneDirectory(): CXoneDirectory

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:33
Create instance for directory session and initialize it
example
```
new DirectoryBase();
```
Returns CXoneDirectory

Properties

Private acdSession

acdSession: ACDSessionManager = ...

addressBookService

addressBookService: AddressBookService

directoryEvent

directoryEvent: Subject<DirectoryResponse> = ...

directoryProvider

directoryProvider: CXoneDirectoryProvider = ...

dynamicDirectory

dynamicDirectory: CXoneDynamicDirectory = ...

onUpdateSkillsEvent

onUpdateSkillsEvent: Subject<AgentSkill[]> = ...

skillAgentsProvider

skillAgentsProvider: CXoneSkillAgentsProvider = ...

Provider for polling agents assigned to a specific skill during drill-down.

skillService

skillService: SkillService

teamService

teamService: TeamService

Static Private singleton

singleton: CXoneDirectory

Methods

Private clearDirectoryDB

clearDirectoryDB(): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:58
Used to clear out the directory data from the index DB before initiating a new directory instance

Returns void

getAgentSkills

getAgentSkills(): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:145
Method to get agent skills
example
```
this.getAgentSkills();
```
Returns void

getDirectoryData

getDirectoryData(directoryRequest: DirectoryRequest): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:70
Used to handle the directory data for polling, non polling and search requests
example
```
getDirectoryData(directoryRequest);
```
Parameters
- directoryRequest: DirectoryRequest
  
  directory request object with pollingOptions, entity, offset, limit and searchText
Returns void

getFavoritesByAddressBook

getFavoritesByAddressBook(AddressBookName: string): Promise<AddressBooksEntries[]>

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:258
Method to get favorites for Address Book entries
example
```
this.getFavoritesByAddressBook(searchText);
```
Parameters
- AddressBookName: string
Returns Promise<AddressBooksEntries[]>

getFavoritesByAgent

getFavoritesByAgent(agentName: string): Promise<AgentStateResponse[]>

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:235
Method to get favorites for Agents
example
```
this.getFavorites(searchText);
```
Parameters
- agentName: string
  
  agent name for filtering the list
Returns Promise<AgentStateResponse[]>

getFavoritesByDigitalSkill

getFavoritesByDigitalSkill(skillName: string): Promise<SkillEvent[]>

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:270
Method to get favorites for Digital Skills
example
```
this.getFavoritesByDigitalSkill(searchText);
```
Parameters
- skillName: string
  
  skill name for filtering the list
Returns Promise<SkillEvent[]>

getFavoritesByTeam

getFavoritesByTeam(teamName: string): Promise<Team[]>

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:247
Method to get favorites for Teams
example
```
this.getFavoritesByTeam(searchText);
```
Parameters
- teamName: string
  
  team name for filtering the list
Returns Promise<Team[]>

getFilteredStandardBookEntries

getFilteredStandardBookEntries(data: { addressBooks: (SAB2AddressBook | AddressBooks)[]; searchText: string; skip: number; top: number }): Promise<AddressBookEntriesResponse[]>

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:110
get Standard Address book entries for all standardbooks for a email autocomplete search
example
```
 this.getFilteredStandardBookEntries({ addressBooks: AddressBooks[];
skip: number;
top: number;
searchText: string;})
```
Parameters
- data: { addressBooks: (SAB2AddressBook | AddressBooks)[]; searchText: string; skip: number; top: number }
  - addressBooks: (SAB2AddressBook | AddressBooks)[]
  - searchText: string
  - skip: number
  - top: number
Returns Promise<AddressBookEntriesResponse[]>

terminateDirectoryPolling

terminateDirectoryPolling(): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:92
Used to terminate directory polling
example
```
this.directoryBase.terminateDirectoryPolling()
```
Returns void

toggleFavoriteForAgent

toggleFavoriteForAgent(agentInfo: AgentStateResponse | AgentStateResponse[]): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:164
Method to toggle favorites for Agents
example
```
this.toggleFavorite(agentInfo);
```
Parameters
- agentInfo: AgentStateResponse | AgentStateResponse[]
  
  agent for which you want to toggle favorite for
Returns void

toggleFavoriteForDigitalSkill

toggleFavoriteForDigitalSkill(skillsInfo: SkillEvent[]): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:187
Method to toggle favorites for digital Skills
example
```
this.toggleFavoriteForDigitalSkill();
```
Parameters
- skillsInfo: SkillEvent[]
Returns void

toggleFavoriteForExternalDirectories

toggleFavoriteForExternalDirectories(externalDirectoryEntries: DirectoryAdditionalAtrributes[]): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:211
Method to toggle favorites for External Directory
example
```
this.toggleFavoriteForExternalDirectories(externalDirectoryEntries);
```
Parameters
- externalDirectoryEntries: DirectoryAdditionalAtrributes[]
  
  external directory entries for which you want to toggle favorite for
Returns void

toggleFavoriteForNewGenDirectories

toggleFavoriteForNewGenDirectories(newGenDirectoryEntries: DirectoryAdditionalAtrributes[]): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:223
Method to toggle favorites for NewGen Directory
example
```
this.toggleFavoriteForNewGenDirectories(newGenDirectoryEntries);
```
Parameters
- newGenDirectoryEntries: DirectoryAdditionalAtrributes[]
  
  NewGen directory entries for which you want to toggle favorite for
Returns void

toggleFavoriteForStandardAddressBookEntries

toggleFavoriteForStandardAddressBookEntries(addressBooksEntries: AddressBooksEntries[]): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:199
Method to toggle favorites for Standard Address Book Entries
example
```
this.toggleFavoriteForStandardAddressBookEntries(addressBooksEntries);
```
Parameters
- addressBooksEntries: AddressBooksEntries[]
  
  address book entries for which you want to toggle favorite for
Returns void

toggleFavoriteForTeams

toggleFavoriteForTeams(teamsInfo: Team[]): void

- Defined in agent-sdk/src/lib/directory/cxone-directory.ts:176
Method to toggle favorites for Teams
example
```
this.toggleFavoriteForTeams(TeamsInfo);
```
Parameters
- teamsInfo: Team[]
  
  team for which you want to toggle favorite for
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CXoneDirectory

Properties

Private acdSession

addressBookService

directoryEvent

directoryProvider

dynamicDirectory

onUpdateSkillsEvent

skillAgentsProvider

skillService

teamService

Static Private singleton

Methods

Private clearDirectoryDB

Returns void

getAgentSkills

Returns void

getDirectoryData

Parameters

directoryRequest: DirectoryRequest

Returns void

getFavoritesByAddressBook

Parameters

AddressBookName: string

Returns Promise<AddressBooksEntries[]>

getFavoritesByAgent

Parameters

agentName: string

Returns Promise<AgentStateResponse[]>

getFavoritesByDigitalSkill

Parameters

skillName: string

Returns Promise<SkillEvent[]>

getFavoritesByTeam

Parameters

teamName: string

Returns Promise<Team[]>

getFilteredStandardBookEntries

Parameters

data: { addressBooks: (SAB2AddressBook | AddressBooks)[]; searchText: string; skip: number; top: number }

addressBooks: (SAB2AddressBook | AddressBooks)[]

searchText: string

skip: number

top: number

Returns Promise<AddressBookEntriesResponse[]>

terminateDirectoryPolling

Returns void

toggleFavoriteForAgent

Parameters

agentInfo: AgentStateResponse | AgentStateResponse[]

Returns void

toggleFavoriteForDigitalSkill

Parameters

skillsInfo: SkillEvent[]

Returns void

toggleFavoriteForExternalDirectories

Parameters

externalDirectoryEntries: DirectoryAdditionalAtrributes[]

Returns void

toggleFavoriteForNewGenDirectories

Parameters

newGenDirectoryEntries: DirectoryAdditionalAtrributes[]

Returns void

toggleFavoriteForStandardAddressBookEntries

Parameters

addressBooksEntries: AddressBooksEntries[]

Returns void

toggleFavoriteForTeams

Parameters

teamsInfo: Team[]

Returns void