Options
All
  • Public
  • Public/Protected
  • All
Menu

This is the base class for ACD

Hierarchy

  • CXoneClient

Index

Constructors

Properties

acdSessionManager: ACDSessionManager = ...
agentAssistWSService: AgentAssistWSService = ...
agentContactHistory: CXoneAgentContactHistory = ...
agentIntegrationConfigurationService: AgentIntegrationConfigurationService = ...
agentPermission: CXoneAgentPermission = ...
agentSetting: CXoneAgentSetting = ...
auth: CXoneAuth = ...
autoSummaryNotificationService: AutoSummaryNotificationService = ...
autoSummaryService: AutoSummaryService = ...
commitment: CommitmentService = ...
common: CommonService = ...
copilotNotificationClient: CopilotNotificationClient = ...
copilotService: CopilotService = ...
cxoneApiPerformanceMetrics: Subject<CXoneApiPerformanceMetrics> = ...
cxoneCustomerCard: CustomerCardService = ...
cxoneTenant: CXoneTenant = ...
cxoneUser: CXoneUser = ...
directory: CXoneDirectory = ...
hasInitModuleInitiated: boolean = false
iexService: IEXService = ...
isUIQueueEnabled: boolean = false
logger: Logger = ...
notification: CXoneNotificationManager = ...
onUpdateSkillsEvent: Subject<AgentSkill[]> = ...
performanceReport: CXoneRealtimeReportService = ...
presenceSyncService: PresenceSyncService = ...
screenAgent: ScreenAgentService = ...
skillActivityQueue: CXoneSkillActivityQueue = ...
teamService: TeamService = ...
transcript: TranscriptService = ...
voiceBioHubService: VoiceBioHubService = ...
wemSchedule: WemSchedule = ...
isCopilotWsConnected: boolean = false
singleton: CXoneClient

Accessors

Methods

  • clearCache(): Promise<void>
  • clearCxoneLocalStorage(): void
  • Clears out all Local Storage except Settings Any other items thst should persist can be added if needed.

    example

    clearCxoneLocalStorage

    Returns void

  • connectCopilotWebSocket(): void
  • Lazily establishes the Copilot (Agent Assist) WebSocket connection when enabled and not already connected.

    This method checks the FeatureToggles.LAZY_LOAD_COPILOT_WEBSOCKET feature toggle and only attempts to connect if the Copilot WebSocket has not yet been marked as connected via CXoneClient.getCopilotWsConnected.

    Connection details are derived from:

    • CXone configuration: aahNotificationWssUri
    • Current user context: icAgentId, userId, icBUId

    If FeatureToggles.MULTI_ACD_WEBSOCKET is enabled, the connection identifier uses userId; otherwise it uses icAgentId. The WebSocket URL is constructed as: aahNotificationWssUri?agentId=<connectionIdentifier>&BUid=<icBUId>.

    On connection attempt, the internal "connected" flag is set optimistically. If the connection attempt throws, the flag is reset and an error is logged.

    Returns void

    void

  • createAgentAssistWSService(): Promise<void>
  • createAutoSummaryNotificationService(): Promise<void>
  • createAutoSummaryService(): Promise<void>
  • handleRefreshTokenSuccess(): Promise<void>
  • initAgentIntegrationConfigurationService(): void
  • method to initialize AgentIntegrationConfigurationService

    example
    CXoneClient.instance.initAgentIntegrationConfigurationService();
    

    Returns void

  • initAuthDependentModules(): Promise<void>
  • Method to initialize auth dependent module when authentication gets successful

    example
    this.initAuthDependentModules();
    

    Returns Promise<void>

  • onLeaderElectionChange(): void
  • subscribeAgentAssistEvent(): void
  • subscribeRequestMessage(): void
  • subscribeResponseMessage(): void
  • terminateCXoneUtilWorker(): void
  • getCopilotWsConnected(): boolean
  • Gets the Copilot notification WebSocket connection status.

    example

    CXoneClient.getCopilotWsConnected();

    Returns boolean

    True if the websocket is connected (or connection is in progress).

  • setCopilotWsConnected(isConnected: boolean): void
  • Sets the Copilot notification WebSocket connection flag.

    example

    CXoneClient.setCopilotWsConnected(false);

    Parameters

    • isConnected: boolean

      True if the websocket is connected (or connection is in progress).

    Returns void

Generated using TypeDoc