Options
All
  • Public
  • Public/Protected
  • All
Menu

Utility for agent session management

Hierarchy

  • ACDSessionManager

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

_agentAssistSubject: Subject<CXoneAgentAssist> = ...
_agentAssistSummarySubject: Subject<GetNextAgentAssistEvent> = ...
_agentAssistWSSubject: ReplaySubject<AgentAssistWSRequest> = ...
_agentIndicatorsSubject: Subject<unknown> = ...
_agentLegSubject: Subject<AgentLegEvent> = ...
_agentStateSubject: Subject<AgentStateEvent> = ...
_agentUnavailableCodeSubject: Subject<UpdateUnavailableCodeEvent> = ...
_agentWorkflowEvent: Subject<AgentWorkflowResponseEvent> = ...
_agentWorkflowRequestEvent: Subject<AgentWorkflowRequestEvent> = ...
_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> }>> = ...
_coBrowseEvent: Subject<CoBrowseEvent> = ...
_contactIndicatorsSubject: Subject<CXoneIndicator> = ...
_customScreenpopSubject: Subject<CXoneCustomScreenpop> = ...
_digitalContactSubject: Subject<DigitalContactEvent> = ...
_mchAgentSettingChangeEvent: Subject<MCHSetting> = ...
_muteEventSubject: Subject<MuteEvent> = ...
_onAgentAssistGetNextEvent: Subject<CXoneAgentAssist> = ...
_onAgentAssistWebSocketUnsubscribe: Subject<string> = ...
_onAgentSessionChange: Subject<AgentSessionResponse> = ...
_onCommitmentEvent: Subject<CommitmentEvent> = ...
_onCommitmentStatusEvent: Subject<CommitmentStatusEvent> = ...
_onConferenceEvent: Subject<string> = ...
_onHoursOfOperationEvent: Subject<unknown> = ...
_onNaturalCallingSkillListEvent: Subject<boolean> = ...
_onNetworkTimeOutEventSubject: Subject<UpdateNetworkTimeoutEvent> = ...
_onUpdateCommitments: Subject<unknown> = ...
_pageOpenSubject: Subject<CXonePageOpen> = ...
_popUrlSubject: Subject<CXonePopUrl> = ...
_runAppSubject: Subject<CXoneRunApp> = ...
_screenPopSubject: Subject<CXoneContactScreenpop> = ...
_updateMessageEvent: Subject<unknown> = ...
_updatePermissionsEventSubject: Subject<UpdatePermissionsEvent> = ...
_updateSkillsEvent: Subject<unknown> = ...
_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> }>> = ...
_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> }>> = ...
_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: string = ''
adminService: AdminService = ...
cxOneConfig: CXoneConfiguration = ...
logger: Logger = ...
sessionId: string = ''
userInfo: UserInfo = ...
utilService: HttpUtilService = ...

Accessors

  • example
    const agentAssistGetNextEventSubject  = acdSession.agentAssistGetNextEventSubject
    

    Returns Subject<CXoneAgentAssist>

  • example
    const agentAssistSubject  = acdSession.agentAssistSubject
    

    Returns Subject<CXoneAgentAssist>

  • example

    -const agentAssistWSSubject = acdSession.agentAssistWSSubject

    Returns ReplaySubject<AgentAssistWSRequest>

  • get agentAssistWebSocketUnsubsribeSubject(): Subject<string>
  • example

    -const agentAssistWebSocketUnsubscribeSubject = acdSession.agentAssistWebSocketUnsubsribeSubject

    Returns Subject<string>

  • get agentIndicatorsSubject(): Subject<unknown>
  • example
    const agentIndicatorsSubject = acdSession.agentIndicatorsSubject
    

    Returns Subject<unknown>

  • example
    const agentLegSubject = acdSession.agentLegSubject
    

    Returns Subject<AgentLegEvent>

  • example
    const agentState = acdSession.agentStateSubject
    

    Returns Subject<AgentStateEvent>

  • Used to get the agent workflow event subject

    example
    const _agentWorkflowEvent = agentSession.agentWorkflowEvent
    

    Returns Subject<AgentWorkflowResponseEvent>

  • Used to get the agent workflow event subject

    example
    const agentWorkflowRequestEvent = agentSession.agentWorkflowRequestEvent
    

    Returns Subject<AgentWorkflowRequestEvent>

  • 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> }>>

  • example
    const coBrowseEvent = acdSession.coBrowseEvent
    

    Returns Subject<CoBrowseEvent>

  • get conferenceCallEvent(): Subject<string>
  • example
    const conferenceCallEvent = acdSession.conferenceCallEvent
    

    Returns Subject<string>

  • example
    const contactIndicatorsSubject = acdSession.contactIndicatorsSubject
    

    Returns Subject<CXoneIndicator>

  • example
    const customScreenpopSubject  = acdSession.customScreenpopSubject   
    

    Returns Subject<CXoneCustomScreenpop>

  • example
    const digitalContactSubject = agentSession.digitalContactSubject
    

    Returns Subject<DigitalContactEvent>

  • get hasSessionId(): boolean
  • Method to sessionId is valid or not

    example
    hasSessionId()
    

    Returns boolean

  • get hoursOfOperationEvent(): Subject<unknown>
  • example
    const hoursOfOperationEvent = acdSession.hoursOfOperationEvent
    

    Returns Subject<unknown>

  • get mchAgentSettingsChangeEvent(): Subject<MCHSetting>
  • example
    const mchAgentSettingsChangeEvent = agentSession.mchAgentSettingsChangeEvent
    

    Returns Subject<MCHSetting>

  • example
    const muteEventSubject = acdSession.muteEventSubject
    

    Returns Subject<MuteEvent>

  • get naturalCallingSkillListEvent(): Subject<boolean>
  • example
    const naturalCallingSkillListEvent = acdSession.naturalCallingSkillListEvent
    

    Returns Subject<boolean>

  • example
    const agentSessionChange = acdSession.onAgentSessionChange
    

    Returns Subject<AgentSessionResponse>

  • example
    const onCommitmentEvent  = agentSession.onCommitmentEvent
    

    Returns Subject<CommitmentEvent>

  • example
    const onCommitmentStatusEvent  = agentSession.onCommitmentStatusEvent
    

    Returns Subject<CommitmentStatusEvent>

  • get onUpdateCommitments(): Subject<unknown>
  • example
    const onUpdateCallbacks  = agentSession.onUpdateCallbacks
    

    Returns Subject<unknown>

  • example
    const pageOpenSubject = agentSession.pageOpenSubject
    

    Returns Subject<CXonePageOpen>

  • example
    const popUrlSubject = agentSession.popUrlSubject
    

    Returns Subject<CXonePopUrl>

  • example
    const runAppSubject = agentSession.runAppSubject
    

    Returns Subject<CXoneRunApp>

  • get updateMessageEvent(): Subject<unknown>
  • example
    const updateMessageEvent = acdSession.updateMessageEvent
    

    Returns Subject<unknown>

  • example
    const updatePermissionsEventSubject = acdSession.updatePermissionsEventSubject
    

    Returns Subject<UpdatePermissionsEvent>

  • get updateSkillsEvent(): Subject<unknown>
  • example
    const updateSkillsEvent = agentSession.updateSkillsEvent
    

    Returns Subject<unknown>

  • 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> }>>

  • 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> }>>

  • 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> }>>

  • Method to create singleton object of the class

    example
    const agentSession = ACDSessionManager.instance;
    

    Returns ACDSessionManager

Methods

  • 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(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

  • Method to initiate adapter to handle events

    example
    const getNextAdapter = agentSession.getNextAdapter
    

    Returns CXoneGetNextAdapter

  • getSessionId(): string
  • example
    const agentSessionId = this.getSessionId();
    

    Returns string

    • agent session id
  • Method to initialize the user details (i.e) cxoneConfig, userInfo and aceessToken

    example
    const agentSession = ACDSessionManager.instance.initialize(accessToken, config, userInfo);
    

    Parameters

    Returns void

  • 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
  • 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(accessToken: string): void
  • example
    this.setAccessToken(accessToken);
    

    Parameters

    • accessToken: string

      access token

    Returns void

  • setSessionId(value: string): void
  • example
    this.setSessionId('SHRxbEd2ZkFyN');
    

    Parameters

    • value: string

      updatedSessionId

    Returns void

  • startGetNextEvents(sessionId?: string): void
  • example
    const startGetNextEvents = agentSession.startGetNextEvents
    

    Parameters

    • Optional sessionId: string

    Returns void

  • Method to start session for an agent

    example
    const startAgentSession = this.startSession(startSessionRequest)
    

    Parameters

    Returns Promise<HttpResponse | CXoneSdkError>

    • response from the start agent session api
  • terminateGetNextPolling(): void
  • Method to terminate get-next polling worker

    example
    const terminateGetNextPolling = agentSession.terminateGetNextPolling
    

    Returns void

  • 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

Generated using TypeDoc