Class CXoneScreenPop

Screen Pop manager class

Hierarchy

CXoneScreenPop

Constructors

constructor

new CXoneScreenPop(): CXoneScreenPop

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:34
example
```
const screenPopManager = new screenPopManager();
```
Returns CXoneScreenPop

Properties

Private acdSessionManager

acdSessionManager: ACDSessionManager = ...

Private agentAssistEvent

agentAssistEvent: Subject<CXoneAgentAssist> = ...

Private contactScreenPopUrl

contactScreenPopUrl: Subject<CXoneContactScreenpop> = ...

Private customScreenpopEvent

customScreenpopEvent: Subject<CXoneCustomScreenpop> = ...

Private logger

logger: Logger = ...

Private pageOpenEvent

pageOpenEvent: Subject<CXonePageOpen> = ...

Private popUrlEvent

popUrlEvent: Subject<CXonePopUrl> = ...

Private runAppEvent

runAppEvent: Subject<CXoneRunApp> = ...

Accessors

agentAssistSubject

get agentAssistSubject(): Subject<CXoneAgentAssist>

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:334
example
```
const cxOneScrrenPop = cxOneScrrenPop.agentAssistSubject
```
Returns Subject<CXoneAgentAssist>

contactScreenPopSubject

get contactScreenPopSubject(): Subject<CXoneContactScreenpop>

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:294
example
```
const cxOneScrrenPop = cxOneScrrenPop.contactScreenPopSubject
```
Returns Subject<CXoneContactScreenpop>

customScreenpopSubject

get customScreenpopSubject(): Subject<CXoneCustomScreenpop>

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:353
example
```
const cxOneCustomScreenPop = cxOneCustomScreenPop.customScreenpopSubject
```
Returns Subject<CXoneCustomScreenpop>

pageOpenSubject

get pageOpenSubject(): Subject<CXonePageOpen>

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:271
example
```
const pageOpenManager = pageOpenManager.pageOpenSubject
```
Returns Subject<CXonePageOpen>

popUrlSubject

get popUrlSubject(): Subject<CXonePopUrl>

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:315
example
```
const cxOneScrrenPop = cxOneScrrenPop.popUrlSubject
```
Returns Subject<CXonePopUrl>

runAppSubject

get runAppSubject(): Subject<CXoneRunApp>

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:113
example
```
const cxOneScrrenPop = cxOneScrrenPop.runAppSubject
```
Returns Subject<CXoneRunApp>

Methods

handlePageOpenActions

handlePageOpenActions(pageOpen: CXonePageOpen): CXonePageOpen

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:284
Handles page open based on actionType
example
```
this.handlePageOpenActions(pageOpen);
```
Parameters
- pageOpen: CXonePageOpen
Returns CXonePageOpen
- updated- page open

handleRunAppActions

handleRunAppActions(runApp: CXoneRunApp): CXoneRunApp

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:126
Handles run app based on actionType
example
```
this.handleRunAppActions(runApp);
```
Parameters
- runApp: CXoneRunApp
  
  received run app event
Returns CXoneRunApp
- updated- run app

onCustomFormSubmit

onCustomFormSubmit(event: any): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:170
Submit function for custom form
example
```
this.onCustomFormSubmit(submitEvent);
```
Parameters
- event: any
  
  submit event with form elements
Returns void

Private prepareHtmlDocument

prepareHtmlDocument(runApp: CXoneRunApp): CXoneRunApp

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:142
Prepares html document for custom form indicator
example
```
this.prepareHtmlDocument(customIndicatorData);
```
Parameters
- runApp: CXoneRunApp
Returns CXoneRunApp
- indicator data with embeded html

Private screenPopForReqagentAndSkills

screenPopForReqagentAndSkills(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:301
subscribe default screen pop and confiqure in 'reqagent' studio

Returns void

screenPopSubscribe

screenPopSubscribe(runApp: boolean, pageOpen: boolean, contactScreenPop: boolean, popUrl: boolean, agentAssist: boolean, customScreenpop: boolean): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:42
subscribe the screen pop event

example
screenPopSubscribe(false,true, true)

Parameters
- runApp: boolean
- pageOpen: boolean
- contactScreenPop: boolean
- popUrl: boolean
- agentAssist: boolean
- customScreenpop: boolean
Returns void

Private subscribeAgentAssistEvent

subscribeAgentAssistEvent(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:341
subscribe the agent assist event

Returns void

Private subscribeCustomScreenpop

subscribeCustomScreenpop(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:360
subscribe the custom screenpop event

Returns void

Private subscribePageOpenEvent

subscribePageOpenEvent(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:98
subscribe the page open event

Returns void

Private subscribePopUrlEvent

subscribePopUrlEvent(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:322
subscribe the popUrl event

Returns void

Private subscribeRunAppEvent

subscribeRunAppEvent(): void

- Defined in acd-sdk/src/lib/acd/contact/cxone-screen-pop.ts:86
subscribe the run app event

Returns void

Generated using TypeDoc