Options
All
  • Public
  • Public/Protected
  • All
Menu

This is the class to manage session mechanism

Hierarchy

  • CXoneSession

Index

Constructors

  • get instance for CXoneSession

    example
    const cxoneSession = new CXoneSession();
    

    Returns CXoneSession

Properties

acdSessionManager: ACDSessionManager = ...
agentStateService: AgentStateService = ...
auth: CXoneAuth = ...
cxoneAcdClient: CXoneAcdClient = ...
hoursOfOperationSubject: Subject<unknown> = ...
naturalCallingSkillListSubject: Subject<boolean> = ...
networkOfflineSubject: Subject<UpdateNetworkTimeoutEvent> = ...
onAgentSessionChange: Subject<AgentSessionResponse> = ...
personalConnectionService: PersonalConnectionService = ...
user: CXoneUser = ...

Accessors

  • example
    const agentLegEvent = CXoneClient.cxoneSession.agentLegEvent
    

    Returns Subject<AgentLegEvent>

Methods

  • Method to end the session

    Parameters

    • endSessionRequest: EndSessionRequest

      object with boolean for forceLogoff, endContacts and ignorePersonalQueue

      @example
      const endSession = this.endSession(endSessionRequest);

    Returns Promise<HttpResponse | CXoneSdkError>

  • Method to join an existing agent session

    @example
    const joinSession = this.joinSession()

    Returns Promise<HttpResponse | CXoneSdkError>

  • method to set agent state, or log in/out of PC dialer

    example
    setAgentState({ state: AgentState })
    

    Parameters

    Returns Promise<HttpResponse | CXoneSdkError>

  • Method to start the session

    Parameters

    • startSessionRequest: StartSessionRequest

      start agent session request object

      @example
      const startSessionObj: StartSessionRequest = {
      stationId: stationId?.current?.value || '',
      stationPhoneNumber: stationPhoneNo?.current?.value || '',
      };
      const startSession = this.startSession(startSessionObj);

    Returns Promise<HttpResponse | CXoneSdkError>

  • subscribeHoursOfOperationEvent(): void
  • Method to subscribe to the hours of operation event

    Returns void

  • subscribeNaturalCallingSkillListEvent(): void
  • Method to subscribe to the natural calling skill list event

    Returns void

  • subscribeNetworkOfflineSubjectChange(): void
  • Method to subscribe network offline subject

    Returns void

  • subscribeOnAgentSessionChange(): void
  • Method to subscribe start session data

    Returns void

Generated using TypeDoc