ACDSessionManager | nice-cxone-acd-agent-apps

Utility for agent session management

Hierarchy

ACDSessionManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ACDSessionManager(): ACDSessionManager

example

const acdSessionManager = new ACDSessionManager();

Returns ACDSessionManager

Properties

Private _agentAssistSubject

_agentAssistSubject: Subject<CXoneAgentAssist> = ...

Private _agentAssistSummarySubject

_agentAssistSummarySubject: Subject<GetNextAgentAssistEvent> = ...

Private _agentAssistWSSubject

_agentAssistWSSubject: ReplaySubject<AgentAssistWSRequest> = ...

Private _agentIndicatorsSubject

_agentIndicatorsSubject: Subject<unknown> = ...

Private _agentLegSubject

_agentLegSubject: Subject<AgentLegEvent> = ...

Private _agentStateSubject

_agentStateSubject: Subject<AgentStateEvent> = ...

Private _agentUnavailableCodeSubject

_agentUnavailableCodeSubject: Subject<UpdateUnavailableCodeEvent> = ...

Private _agentWorkflowEvent

_agentWorkflowEvent: Subject<AgentWorkflowResponseEvent> = ...

Private _agentWorkflowRequestEvent

_agentWorkflowRequestEvent: Subject<AgentWorkflowRequestEvent> = ...

Private _callContactEventSubject

_callContactEventSubject: Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>> = ...

Private _coBrowseEvent

_coBrowseEvent: Subject<CoBrowseEvent> = ...

Private _contactIndicatorsSubject

_contactIndicatorsSubject: Subject<CXoneIndicator> = ...

Private _customScreenpopSubject

_customScreenpopSubject: Subject<CXoneCustomScreenpop> = ...

Private _digitalContactSubject

_digitalContactSubject: Subject<DigitalContactEvent> = ...

Private _mchAgentSettingChangeEvent

_mchAgentSettingChangeEvent: Subject<MCHSetting> = ...

Private _muteEventSubject

_muteEventSubject: Subject<MuteEvent> = ...

Private _onAgentAssistGetNextEvent

_onAgentAssistGetNextEvent: Subject<CXoneAgentAssist> = ...

Private _onAgentAssistWebSocketUnsubscribe

_onAgentAssistWebSocketUnsubscribe: Subject<string> = ...

Private _onAgentSessionChange

_onAgentSessionChange: Subject<AgentSessionResponse> = ...

Private _onCommitmentEvent

_onCommitmentEvent: Subject<CommitmentEvent> = ...

Private _onCommitmentStatusEvent

_onCommitmentStatusEvent: Subject<CommitmentStatusEvent> = ...

Private _onConferenceEvent

_onConferenceEvent: Subject<string> = ...

Private _onHoursOfOperationEvent

_onHoursOfOperationEvent: Subject<unknown> = ...

Private _onNaturalCallingSkillListEvent

_onNaturalCallingSkillListEvent: Subject<boolean> = ...

Private _onNetworkTimeOutEventSubject

_onNetworkTimeOutEventSubject: Subject<UpdateNetworkTimeoutEvent> = ...

Private _onUpdateCommitments

_onUpdateCommitments: Subject<unknown> = ...

Private _pageOpenSubject

_pageOpenSubject: Subject<CXonePageOpen> = ...

Private _popUrlSubject

_popUrlSubject: Subject<CXonePopUrl> = ...

Private _runAppSubject

_runAppSubject: Subject<CXoneRunApp> = ...

Private _screenPopSubject

_screenPopSubject: Subject<CXoneContactScreenpop> = ...

Private _updateMessageEvent

_updateMessageEvent: Subject<unknown> = ...

Private _updatePermissionsEventSubject

_updatePermissionsEventSubject: Subject<UpdatePermissionsEvent> = ...

Private _updateSkillsEvent

_updateSkillsEvent: Subject<unknown> = ...

Private _voiceMailContactEventSubject

_voiceMailContactEventSubject: Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; createdDate: RequiredDateSchema<Date, AnyObject>; customData: default<string, AnyObject, string>; fileDuration: RequiredNumberSchema<number, AnyObject>; fileName: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; from: default<string, AnyObject, string>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; label: default<string, AnyObject, string>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; masterID: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parentContactId: default<string, AnyObject, string>; requireDisposition: default<boolean, AnyObject, boolean>; screenPopUrl: RequiredStringSchema<string, AnyObject>; skill: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; to: default<string, AnyObject, string>; type: default<string, AnyObject, string>; voiceMailType: default<string, AnyObject, string> }>> = ...

Private _voiceMailPlayBackSubject

_voiceMailPlayBackSubject: Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; iisHost: default<string, AnyObject, string>; playBackPaused: RequiredBooleanSchema<boolean, AnyObject>; playBackPosition: RequiredNumberSchema<number, AnyObject>; type: RequiredStringSchema<string, AnyObject>; vcHost: default<string, AnyObject, string> }>> = ...

Private _workItemContactEventSubject

_workItemContactEventSubject: Subject<AssertsShape<{ agentId: RequiredNumberSchema<number, AnyObject>; closePopoutUponTermination: default<boolean, AnyObject, boolean>; contactId: RequiredStringSchema<string, AnyObject>; customData: default<string, AnyObject, string>; finalState: RequiredBooleanSchema<boolean, AnyObject>; iisHost: default<string, AnyObject, string>; inFocus: default<boolean, AnyObject, boolean>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parenContactId: default<string, AnyObject, string>; popDestination: default<string, AnyObject, string>; popoutWindowHeight: default<number, AnyObject, number>; popoutWindowWidth: default<number, AnyObject, number>; refusalTimeout: default<number, AnyObject, number>; screenPopUrl: RequiredStringSchema<string, AnyObject>; sessionId: RequiredStringSchema<string, AnyObject>; skillId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; tabTitle: default<string, AnyObject, string>; type: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string>; vcHost: default<string, AnyObject, string>; workItemId: default<string, AnyObject, string>; workItemPayload: default<string, AnyObject, string>; workItemType: default<string, AnyObject, string> }>> = ...

accessToken

accessToken: string = ''

Private adminService

adminService: AdminService = ...

cxOneConfig

cxOneConfig: CXoneConfiguration = ...

Protected logger

logger: Logger = ...

Private sessionId

sessionId: string = ''

userInfo

userInfo: UserInfo = ...

Protected utilService

utilService: HttpUtilService = ...

Static Private singleton

singleton: ACDSessionManager

Accessors

agentAssistGetNextEventSubject

get agentAssistGetNextEventSubject(): Subject<CXoneAgentAssist>

example

const agentAssistGetNextEventSubject  = acdSession.agentAssistGetNextEventSubject

Returns Subject<CXoneAgentAssist>

agentAssistSubject

get agentAssistSubject(): Subject<CXoneAgentAssist>

example

const agentAssistSubject  = acdSession.agentAssistSubject

Returns Subject<CXoneAgentAssist>

agentAssistSummarySubject

get agentAssistSummarySubject(): Subject<GetNextAgentAssistEvent>

example
-const agentAssistSubject = acdSession.agentAssistSubject

Returns Subject<GetNextAgentAssistEvent>

agentAssistWSSubject

get agentAssistWSSubject(): ReplaySubject<AgentAssistWSRequest>

example
-const agentAssistWSSubject = acdSession.agentAssistWSSubject

Returns ReplaySubject<AgentAssistWSRequest>

agentAssistWebSocketUnsubsribeSubject

get agentAssistWebSocketUnsubsribeSubject(): Subject<string>

example
-const agentAssistWebSocketUnsubscribeSubject = acdSession.agentAssistWebSocketUnsubsribeSubject

Returns Subject<string>

agentIndicatorsSubject

get agentIndicatorsSubject(): Subject<unknown>

example

const agentIndicatorsSubject = acdSession.agentIndicatorsSubject

Returns Subject<unknown>

agentLegSubject

get agentLegSubject(): Subject<AgentLegEvent>

example

const agentLegSubject = acdSession.agentLegSubject

Returns Subject<AgentLegEvent>

agentStateSubject

get agentStateSubject(): Subject<AgentStateEvent>

example

const agentState = acdSession.agentStateSubject

Returns Subject<AgentStateEvent>

agentUpdateUnavailableCodeSubject

get agentUpdateUnavailableCodeSubject(): Subject<UpdateUnavailableCodeEvent>

example

const updateUnavailableCode = acdSession.agentUpdateUnavailableCodeSubject

Returns Subject<UpdateUnavailableCodeEvent>

agentWorkflowEvent

get agentWorkflowEvent(): Subject<AgentWorkflowResponseEvent>

Used to get the agent workflow event subject
example
```
const _agentWorkflowEvent = agentSession.agentWorkflowEvent
```
Returns Subject<AgentWorkflowResponseEvent>

agentWorkflowRequestEvent

get agentWorkflowRequestEvent(): Subject<AgentWorkflowRequestEvent>

Used to get the agent workflow event subject
example
```
const agentWorkflowRequestEvent = agentSession.agentWorkflowRequestEvent
```
Returns Subject<AgentWorkflowRequestEvent>

callContactEventSubject

get callContactEventSubject(): Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>>

example
```
const callContactEventSubject  = acdSession.callContactEventSubject
```
Returns Subject<AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>>

coBrowseEvent

get coBrowseEvent(): Subject<CoBrowseEvent>

example

const coBrowseEvent = acdSession.coBrowseEvent

Returns Subject<CoBrowseEvent>

conferenceCallEvent

get conferenceCallEvent(): Subject<string>

example

const conferenceCallEvent = acdSession.conferenceCallEvent

Returns Subject<string>

contactIndicatorsSubject

get contactIndicatorsSubject(): Subject<CXoneIndicator>

example

const contactIndicatorsSubject = acdSession.contactIndicatorsSubject

Returns Subject<CXoneIndicator>

customScreenpopSubject

get customScreenpopSubject(): Subject<CXoneCustomScreenpop>

example

const customScreenpopSubject  = acdSession.customScreenpopSubject

Returns Subject<CXoneCustomScreenpop>

digitalContactSubject

get digitalContactSubject(): Subject<DigitalContactEvent>

example

const digitalContactSubject = agentSession.digitalContactSubject

Returns Subject<DigitalContactEvent>

hasSessionId

get hasSessionId(): boolean

Method to sessionId is valid or not
example
```
hasSessionId()
```
Returns boolean

hoursOfOperationEvent

get hoursOfOperationEvent(): Subject<unknown>

example

const hoursOfOperationEvent = acdSession.hoursOfOperationEvent

Returns Subject<unknown>

mchAgentSettingsChangeEvent

get mchAgentSettingsChangeEvent(): Subject<MCHSetting>

example

const mchAgentSettingsChangeEvent = agentSession.mchAgentSettingsChangeEvent

Returns Subject<MCHSetting>

muteEventSubject

get muteEventSubject(): Subject<MuteEvent>

example

const muteEventSubject = acdSession.muteEventSubject

Returns Subject<MuteEvent>

naturalCallingSkillListEvent

get naturalCallingSkillListEvent(): Subject<boolean>

example

const naturalCallingSkillListEvent = acdSession.naturalCallingSkillListEvent

Returns Subject<boolean>

networkOfflineSubject

get networkOfflineSubject(): Subject<UpdateNetworkTimeoutEvent>

example

const networkOfflineSubject = acdSession.networkOfflineEventSubject

Returns Subject<UpdateNetworkTimeoutEvent>

onAgentSessionChange

get onAgentSessionChange(): Subject<AgentSessionResponse>

example

const agentSessionChange = acdSession.onAgentSessionChange

Returns Subject<AgentSessionResponse>

onCommitmentEvent

get onCommitmentEvent(): Subject<CommitmentEvent>

example

const onCommitmentEvent  = agentSession.onCommitmentEvent

Returns Subject<CommitmentEvent>

onCommitmentStatusEvent

get onCommitmentStatusEvent(): Subject<CommitmentStatusEvent>

example

const onCommitmentStatusEvent  = agentSession.onCommitmentStatusEvent

Returns Subject<CommitmentStatusEvent>

onUpdateCommitments

get onUpdateCommitments(): Subject<unknown>

example

const onUpdateCallbacks  = agentSession.onUpdateCallbacks

Returns Subject<unknown>

pageOpenSubject

get pageOpenSubject(): Subject<CXonePageOpen>

example

const pageOpenSubject = agentSession.pageOpenSubject

Returns Subject<CXonePageOpen>

popUrlSubject

get popUrlSubject(): Subject<CXonePopUrl>

example

const popUrlSubject = agentSession.popUrlSubject

Returns Subject<CXonePopUrl>

runAppSubject

get runAppSubject(): Subject<CXoneRunApp>

example

const runAppSubject = agentSession.runAppSubject

Returns Subject<CXoneRunApp>

screenPopSubject

get screenPopSubject(): Subject<CXoneContactScreenpop>

example

const screenPopSubject  = acdSession.screenPopSubject

Returns Subject<CXoneContactScreenpop>

updateMessageEvent

get updateMessageEvent(): Subject<unknown>

example

const updateMessageEvent = acdSession.updateMessageEvent

Returns Subject<unknown>

updatePermissionsEventSubject

get updatePermissionsEventSubject(): Subject<UpdatePermissionsEvent>

example

const updatePermissionsEventSubject = acdSession.updatePermissionsEventSubject

Returns Subject<UpdatePermissionsEvent>

updateSkillsEvent

get updateSkillsEvent(): Subject<unknown>

example

const updateSkillsEvent = agentSession.updateSkillsEvent

Returns Subject<unknown>

voiceMailContactEventSubject

get voiceMailContactEventSubject(): Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; createdDate: RequiredDateSchema<Date, AnyObject>; customData: default<string, AnyObject, string>; fileDuration: RequiredNumberSchema<number, AnyObject>; fileName: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; from: default<string, AnyObject, string>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; label: default<string, AnyObject, string>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; masterID: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parentContactId: default<string, AnyObject, string>; requireDisposition: default<boolean, AnyObject, boolean>; screenPopUrl: RequiredStringSchema<string, AnyObject>; skill: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; to: default<string, AnyObject, string>; type: default<string, AnyObject, string>; voiceMailType: default<string, AnyObject, string> }>>

example
```
const voiceMailContactEventSubject  = acdSession.voiceMailContactEventSubject
```
Returns Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; createdDate: RequiredDateSchema<Date, AnyObject>; customData: default<string, AnyObject, string>; fileDuration: RequiredNumberSchema<number, AnyObject>; fileName: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; from: default<string, AnyObject, string>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; label: default<string, AnyObject, string>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; masterID: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parentContactId: default<string, AnyObject, string>; requireDisposition: default<boolean, AnyObject, boolean>; screenPopUrl: RequiredStringSchema<string, AnyObject>; skill: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; to: default<string, AnyObject, string>; type: default<string, AnyObject, string>; voiceMailType: default<string, AnyObject, string> }>>

voiceMailPlayBackEventSubject

get voiceMailPlayBackEventSubject(): Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; iisHost: default<string, AnyObject, string>; playBackPaused: RequiredBooleanSchema<boolean, AnyObject>; playBackPosition: RequiredNumberSchema<number, AnyObject>; type: RequiredStringSchema<string, AnyObject>; vcHost: default<string, AnyObject, string> }>>

example
```
const voiceMailPlayBackEventSubject  = acdSession.voiceMailPlayBackEventSubject
```
Returns Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; iisHost: default<string, AnyObject, string>; playBackPaused: RequiredBooleanSchema<boolean, AnyObject>; playBackPosition: RequiredNumberSchema<number, AnyObject>; type: RequiredStringSchema<string, AnyObject>; vcHost: default<string, AnyObject, string> }>>

workItemContactEventSubject

get workItemContactEventSubject(): Subject<AssertsShape<{ agentId: RequiredNumberSchema<number, AnyObject>; closePopoutUponTermination: default<boolean, AnyObject, boolean>; contactId: RequiredStringSchema<string, AnyObject>; customData: default<string, AnyObject, string>; finalState: RequiredBooleanSchema<boolean, AnyObject>; iisHost: default<string, AnyObject, string>; inFocus: default<boolean, AnyObject, boolean>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parenContactId: default<string, AnyObject, string>; popDestination: default<string, AnyObject, string>; popoutWindowHeight: default<number, AnyObject, number>; popoutWindowWidth: default<number, AnyObject, number>; refusalTimeout: default<number, AnyObject, number>; screenPopUrl: RequiredStringSchema<string, AnyObject>; sessionId: RequiredStringSchema<string, AnyObject>; skillId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; tabTitle: default<string, AnyObject, string>; type: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string>; vcHost: default<string, AnyObject, string>; workItemId: default<string, AnyObject, string>; workItemPayload: default<string, AnyObject, string>; workItemType: default<string, AnyObject, string> }>>

example
```
const workitemContactEventSubject = acdSession.workitemContactEventSubject
```
Returns Subject<AssertsShape<{ agentId: RequiredNumberSchema<number, AnyObject>; closePopoutUponTermination: default<boolean, AnyObject, boolean>; contactId: RequiredStringSchema<string, AnyObject>; customData: default<string, AnyObject, string>; finalState: RequiredBooleanSchema<boolean, AnyObject>; iisHost: default<string, AnyObject, string>; inFocus: default<boolean, AnyObject, boolean>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parenContactId: default<string, AnyObject, string>; popDestination: default<string, AnyObject, string>; popoutWindowHeight: default<number, AnyObject, number>; popoutWindowWidth: default<number, AnyObject, number>; refusalTimeout: default<number, AnyObject, number>; screenPopUrl: RequiredStringSchema<string, AnyObject>; sessionId: RequiredStringSchema<string, AnyObject>; skillId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; tabTitle: default<string, AnyObject, string>; type: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string>; vcHost: default<string, AnyObject, string>; workItemId: default<string, AnyObject, string>; workItemPayload: default<string, AnyObject, string>; workItemType: default<string, AnyObject, string> }>>

Static instance

get instance(): ACDSessionManager

Method to create singleton object of the class
example
```
const agentSession = ACDSessionManager.instance;
```
Returns ACDSessionManager

Methods

endSession

endSession(endSessionRequest: EndSessionRequest): Promise<HttpResponse | CXoneSdkError>

Method to end an agent session
example
```
const angentEndSession = this.endSession(endSessionRequest);
```
Parameters
- endSessionRequest: EndSessionRequest
  
  object with boolean for forceLogoff, endContacts and ignorePersonalQueue
Returns Promise<HttpResponse | CXoneSdkError>
- response to end session of an agent

establishUIQSocketConnection

establishUIQSocketConnection(invokeSnapshot?: boolean): void

Method to establish UIQueue socket connection
example
```
const establishUIQSocketConnection = agentSession.establishUIQSocketConnection(true)
```
Parameters
- Optional invokeSnapshot: boolean
  
  flag to invoke snapshot request
Returns void

getNextAdapter

getNextAdapter(): CXoneGetNextAdapter

Method to initiate adapter to handle events
example
```
const getNextAdapter = agentSession.getNextAdapter
```
Returns CXoneGetNextAdapter

getSessionId

getSessionId(): string

example

const agentSessionId = this.getSessionId();

Returns string

agent session id

initialize

initialize(accessToken: string, config: CXoneConfiguration, userInfo: UserInfo): void

Method to initialize the user details (i.e) cxoneConfig, userInfo and aceessToken
example
```
const agentSession = ACDSessionManager.instance.initialize(accessToken, config, userInfo);
```
Parameters
- accessToken: string
  
  Access token
- config: CXoneConfiguration
  
  cxoneConfig object
- userInfo: UserInfo
  
  user info object
Returns void

joinSession

joinSession(options?: { agentId: number }): Promise<HttpResponse | CXoneSdkError>

Method to join session for an agent
example
```
const agentObj = {agentId: 23}
const joinACDSession = this.joinSession(agentObj)
```
Parameters
- Optional options: { agentId: number }
  
  input parameters for the method includes agent id
  - agentId: number
Returns Promise<HttpResponse | CXoneSdkError>
- response from the join agent session api

postCustomFormData

postCustomFormData(contactId: string, customFormData: CustomFormData): Promise<HttpResponse | CXoneSdkError>

Posts custom form data
example
```
this.postCustomFormData('1234', customFormData);
```
Parameters
- contactId: string
  
  sendor contact id
- customFormData: CustomFormData
  
  custom form data with '|' delimited string for each key/value
Returns Promise<HttpResponse | CXoneSdkError>
- response for custom data api

setAccessToken

setAccessToken(accessToken: string): void

example
```
this.setAccessToken(accessToken);
```
Parameters
- accessToken: string
  
  access token
Returns void

setSessionId

setSessionId(value: string): void

example
```
this.setSessionId('SHRxbEd2ZkFyN');
```
Parameters
- value: string
  
  updatedSessionId
Returns void

startGetNextEvents

startGetNextEvents(sessionId?: string): void

example

const startGetNextEvents = agentSession.startGetNextEvents

Parameters

Optional sessionId: string

Returns void

startSession

startSession(startSessionRequest: StartSessionRequest): Promise<HttpResponse | CXoneSdkError>

Method to start session for an agent
example
```
const startAgentSession = this.startSession(startSessionRequest)
```
Parameters
- startSessionRequest: StartSessionRequest
  
  Object of type StartSessionRequest.
Returns Promise<HttpResponse | CXoneSdkError>
- response from the start agent session api

terminateGetNextPolling

terminateGetNextPolling(): void

Method to terminate get-next polling worker

example

const terminateGetNextPolling = agentSession.terminateGetNextPolling

Returns void

toggleAgentEventsReceivingMethod

toggleAgentEventsReceivingMethod(invokeSnapshot?: boolean, sessionId?: string): void

Method to switch between Uiq and get-next polling
example
```
this.toggleAgentEventsReceivingMethod(invokeSnapshot, sessionId)
```
Parameters
- Optional invokeSnapshot: boolean
  
  Flag to receive to snapshot
- Optional sessionId: string
  
  session id
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ACDSessionManager

Properties

Private _agentAssistSubject

Private _agentAssistSummarySubject

Private _agentAssistWSSubject

Private _agentIndicatorsSubject

Private _agentLegSubject

Private _agentStateSubject

Private _agentUnavailableCodeSubject

Private _agentWorkflowEvent

Private _agentWorkflowRequestEvent

Private _callContactEventSubject

Private _coBrowseEvent

Private _contactIndicatorsSubject

Private _customScreenpopSubject

Private _digitalContactSubject

Private _mchAgentSettingChangeEvent

Private _muteEventSubject

Private _onAgentAssistGetNextEvent

Private _onAgentAssistWebSocketUnsubscribe

Private _onAgentSessionChange

Private _onCommitmentEvent

Private _onCommitmentStatusEvent

Private _onConferenceEvent

Private _onHoursOfOperationEvent

Private _onNaturalCallingSkillListEvent

Private _onNetworkTimeOutEventSubject

Private _onUpdateCommitments

Private _pageOpenSubject

Private _popUrlSubject

Private _runAppSubject

Private _screenPopSubject

Private _updateMessageEvent

Private _updatePermissionsEventSubject

Private _updateSkillsEvent

Private _voiceMailContactEventSubject

Private _voiceMailPlayBackSubject

Private _workItemContactEventSubject

accessToken

Private adminService

cxOneConfig

Protected logger

Private sessionId

userInfo

Protected utilService

Static Private singleton

Accessors

agentAssistGetNextEventSubject

Returns Subject<CXoneAgentAssist>

agentAssistSubject

Returns Subject<CXoneAgentAssist>

agentAssistSummarySubject

Returns Subject<GetNextAgentAssistEvent>

agentAssistWSSubject

Returns ReplaySubject<AgentAssistWSRequest>

agentAssistWebSocketUnsubsribeSubject

Returns Subject<string>

agentIndicatorsSubject

Returns Subject<unknown>

agentLegSubject

Returns Subject<AgentLegEvent>

agentStateSubject

Returns Subject<AgentStateEvent>

agentUpdateUnavailableCodeSubject

Returns Subject<UpdateUnavailableCodeEvent>

agentWorkflowEvent

Returns Subject<AgentWorkflowResponseEvent>

agentWorkflowRequestEvent

Returns Subject<AgentWorkflowRequestEvent>

callContactEventSubject

coBrowseEvent

Returns Subject<CoBrowseEvent>