Class CXoneSkillActivityProvider

skill activity Provider Class

Hierarchy

CXoneSkillActivityProvider

Constructors

constructor

new CXoneSkillActivityProvider(): CXoneSkillActivityProvider

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:63
Creates skill activity provider
example
- const provider = new CXoneSkillActivityProvider();
Returns CXoneSkillActivityProvider

Properties

Private acdSession

acdSession: ACDSessionManager = ACDSessionManager.instance

Private baseUri

baseUri: string = ''

Private cxoneClient

cxoneClient: CXoneClient = ...

Private entityCounts

entityCounts: { skillList: number } = ...

Type declaration

skillList: number

Private favoriteSkillList

favoriteSkillList: SkillActivityEvent[] = []

Private isOutbound

isOutbound: boolean = false

Private limit

limit: number = -1

Private logger

logger: Logger = ...

Private mediaTypeId

mediaTypeId: number = undefined

Private offset

offset: number = -1

pollingWorker

pollingWorker: any

Private searchText

searchText: string = ''

Private skillActivityPollingRequest

skillActivityPollingRequest: SkillActivityPollingRequest = {}

Private totalSearchResultCount

totalSearchResultCount: { skillList: number } = ...

Type declaration

skillList: number

Private utilService

utilService: HttpUtilService = ...

Methods

Private filterActiveSkillswithMediatype

filterActiveSkillswithMediatype(skillActivityEvent: SkillActivityEvent[]): SkillActivityEvent[]

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:459
method to filter skill list on the basis on mediatype, isActive and isOutbound property
example
```
this.filterActiveSkillswithMediatype([SkillActivityEvent, SkillActivityEvent]);
```
Parameters
- skillActivityEvent: SkillActivityEvent[]
  
  List of skillActivityEvent
Returns SkillActivityEvent[]

Private filterSkillwithMediatype

filterSkillwithMediatype(skillActivityEvent: SkillActivityEvent[]): SkillActivityEvent[]

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:441
method to filter skill list on the basis on mediatypeid and isoutbound property
example
```
this.filterSkillwithMediatype();
```
Parameters
- skillActivityEvent: SkillActivityEvent[]
Returns SkillActivityEvent[]

Private formatSkillActivityResponse

formatSkillActivityResponse(response: any): SkillActivityEvent[]

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:256
This method to format skill activity response
example
```
formatSkillActivityResponse(response);
```
Parameters
- response: any
  
  activity api response object
Returns SkillActivityEvent[]
- array of skill activity's

getFavoritesBySkill

getFavoritesBySkill(skillName: string): Promise<SkillActivityEvent[]>

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:580
Used to retrieve skill list from index DB and filter out favorites

example
skillActivityProvider.getFavoritesBySkill(searchText);

Parameters
- skillName: string
Returns Promise<SkillActivityEvent[]>

Private getFilteredSkillList

getFilteredSkillList(searchText: string, skillList: SkillActivityEvent[]): SkillActivityEvent[]

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:610
Used to handle the skillList pagination for the search result if the search text is matched and then returns only the data based on offset and limit

Parameters
- searchText: string
  
  search string
- skillList: SkillActivityEvent[]
  
  array of skill
Returns SkillActivityEvent[]

getSkillActivityPolling

getSkillActivityPolling(): any

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:319
Checks if skill activity polling is running
example
```
const isSkillActivityPolling =  this.getSkillActivityPolling();
```
Returns any
- local storage key for skill activity polling

Private getSkillsFromIndexDB

getSkillsFromIndexDB(): Promise<void>

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:88
Used to get the skill data from index DB
example
```
getSkillsFromIndexDB();
```
Returns Promise<void>

Private handleDirectoryPagination

handleDirectoryPagination(): Promise<SkillActivityResponse>

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:411
Used to handle the pagination based on the offset and limit in case of normal directory request flow without search request

Returns Promise<SkillActivityResponse>

handleSkillActivityResponse

handleSkillActivityResponse(response: any): Promise<void>

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:209
Callback method which will passed on to the worker and will be executed after the polling api response then will publish to the subject subscriber with activity data
example
```
handleSkillActivityResponse(data);
```
Parameters
- response: any
  
  activity api response object
Returns Promise<void>

initSkillActivityWorker

initSkillActivityWorker(): void

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:277
Use to initializing the skill activity worker and will return the method inside the worker
example
```
this.initSkillActivityWorker();
```
Returns void

restartWorker

restartWorker(): void

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:292
Restarts skill activity worker when new auth token received from Refresh token flow
example
```
this.restartWorker();
```
Returns void

setACDSdkBaseInstance

setACDSdkBaseInstance(cxoneClient: CXoneClient): void

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:77
Used to set the acd sdk base instance to access the subject from the base class
example
Parameters
- cxoneClient: CXoneClient
Returns void

Private sortResponse

sortResponse(skillList: SkillActivityEvent[]): SkillActivityEvent[]

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:476
Use to sort skill list in ascending order
example
```
this.sortResponse(skillList)
```
Parameters
- skillList: SkillActivityEvent[]
Returns SkillActivityEvent[]

startPolling

startPolling(skillActivityPollingRequest: SkillActivityPollingRequest): Promise<void>

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:125
Used to initiate the polling for skill activity data
example
```
const skillActivityProvider = new CXoneSkillActivityProvider();
this.skillActivityProvider.startPolling();
```
Parameters
- skillActivityPollingRequest: SkillActivityPollingRequest
Returns Promise<void>

Private terminateAgentWorker

terminateAgentWorker(): void

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:306
Use to terminate the skill activity worker
example
```
this.terminateAgentWorker
```
Returns void

terminatePolling

terminatePolling(): void

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:195
Used to terminate the polling of skill activity
example
```
const agentActivityProvider = new CXoneSkillActivityProvider();
this.agentActivityProvider.terminatePolling();
```
Returns void

toggleFavoriteForSkill

toggleFavoriteForSkill(skillInfo: SkillActivityEvent[]): Promise<void>

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:496
Used to toggle the favorite marker for skill and store it in Index DB

example
directoryProvider.toggleFavoriteForSkill(skill);

Parameters
- skillInfo: SkillActivityEvent[]
Returns Promise<void>

Private updateSkillListInDB

updateSkillListInDB(SkillList: SkillActivityEvent[]): Promise<{ currentFavSkillActivityList: SkillActivityEvent[]; currentSkillList: SkillActivityEvent[] }>

- Defined in agent-sdk/src/lib/acd/provider/cxone-skill-activity-provider.ts:330
Used to update the skill list in index DB as per the new list

Parameters
- SkillList: SkillActivityEvent[]
  
  new skill list response
Returns Promise<{ currentFavSkillActivityList: SkillActivityEvent[]; currentSkillList: SkillActivityEvent[] }>

Generated using TypeDoc