Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CXoneClientData

Model class for Client Data

Hierarchy

  • CXoneClientData

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional autoAccept

autoAccept?: boolean
remarks
  • Indicates whether calls should be auto accepted

Optional avNotification

avNotification?: CXoneAudioVisualNotificationSettings
remarks
  • Audio-visual notification settings

Optional cxaFavAgents

cxaFavAgents?: number[]
remarks
  • Favorite agents

Optional cxaFavDigitalSkills

cxaFavDigitalSkills?: number[]
remarks
  • Favorite Digital Skill Activity

Optional cxaFavExtDirectory

cxaFavExtDirectory?: string[]
remarks
  • Favorite external directory entries

Optional cxaFavInQuickRep

cxaFavInQuickRep?: number[]
remarks
  • Favorite quick replies for inbound

Optional cxaFavNewGenDirectory

cxaFavNewGenDirectory?: string[]
remarks
  • Favorite newgen directory entries

Optional cxaFavOutQuickRep

cxaFavOutQuickRep?: number[]
remarks
  • Favorite quick replies for outbound

Optional cxaFavSkills

cxaFavSkills?: number[]
remarks
  • Favorite Skill Activity

Optional cxaFavStandAddBook

cxaFavStandAddBook?: number[]
remarks
  • Favorite Address Book

Optional cxaFavStates

cxaFavStates?: number[]
remarks
  • Favorite State Selector

Optional cxaFavTeams

cxaFavTeams?: number[]
remarks
  • Favorite teams

Optional cxaSearchAppSettings

cxaSearchAppSettings?: CXoneSearchAppTabs
remarks
  • Search app settings

Optional emailMessageSortOrder

emailMessageSortOrder?: string
remarks
  • Email message sort order

Optional expandSoftphone

expandSoftphone?: boolean
remarks
  • Expand the agent softphone when receives new interaction

Optional integratedSoftphone

integratedSoftphone?: CXoneSoftphoneNotificationSettings
remarks
  • Integrated softphone notification settings

Optional loggingLevel

loggingLevel?: number
remarks
  • Logging level for the application

Optional pageActionPopout

pageActionPopout?: boolean
remarks
  • Indicates whether to enable PAGE action popout

Optional panelPopout

panelPopout?: boolean
remarks
  • Indicates whether to enable panel popout

Optional pinnedMenuItem

pinnedMenuItem?: string
remarks
  • Pinned menu item name

Optional quickAppSequence

quickAppSequence?: string | object
remarks
  • Quick app sequence Can be ultra-compressed string (Phase 2), compressed object (Phase 1), or legacy object

Optional sendOnEnter

sendOnEnter?: string
remarks
  • Indicates whether to send message on enter key press

Optional twentyFourHourTime

twentyFourHourTime?: boolean
remarks
  • Indicates whether to use 24-hour time format

Methods

mapper

  • mapper(currentClientDataObj: any, data: CXoneClientData): { AudioAgentMessage: any; AudioAgentMessageTone: any; AudioEndContact: any; AudioEndContactTone: any; AudioNewChat: any; AudioNewContact: any; AudioNewContactReplyTone: any; AudioNewContactTone: any; AutoAccept: any; CXAFavAgents: any; CXAFavDigitalSkills: any; CXAFavExtDirectory: any; CXAFavInQuickRep: any; CXAFavNewGenDirectory: any; CXAFavOutQuickRep: any; CXAFavSkills: any; CXAFavStandAddBook: any; CXAFavStates: any; CXAFavTeams: any; CXARingtone: any; CXASecondaryDevice: any; CXASecondaryDeviceName: any; ExpandSoftphone: any; LoggingLevel: any; PageActionPopout: any; Panels: any; SecondaryDeviceDelay: any; SendOnEnter: any; Use24HourTime: any; VisualAgentMessage: any; VisualEndContact: any; VisualNewChat: any; VisualNewContact: any; emailMessageSortOrder: any; pinnedMenuItem: any; quickAppSequence: any; softPhoneVolume: any }

  • This method is to map CXoneClientData to client Data that is sent in payload

    example
    mapper(clientData, consumerUpdatedData);

    Parameters

    Returns { AudioAgentMessage: any; AudioAgentMessageTone: any; AudioEndContact: any; AudioEndContactTone: any; AudioNewChat: any; AudioNewContact: any; AudioNewContactReplyTone: any; AudioNewContactTone: any; AutoAccept: any; CXAFavAgents: any; CXAFavDigitalSkills: any; CXAFavExtDirectory: any; CXAFavInQuickRep: any; CXAFavNewGenDirectory: any; CXAFavOutQuickRep: any; CXAFavSkills: any; CXAFavStandAddBook: any; CXAFavStates: any; CXAFavTeams: any; CXARingtone: any; CXASecondaryDevice: any; CXASecondaryDeviceName: any; ExpandSoftphone: any; LoggingLevel: any; PageActionPopout: any; Panels: any; SecondaryDeviceDelay: any; SendOnEnter: any; Use24HourTime: any; VisualAgentMessage: any; VisualEndContact: any; VisualNewChat: any; VisualNewContact: any; emailMessageSortOrder: any; pinnedMenuItem: any; quickAppSequence: any; softPhoneVolume: any }

    • AudioAgentMessage: any
    • AudioAgentMessageTone: any
    • AudioEndContact: any
    • AudioEndContactTone: any
    • AudioNewChat: any
    • AudioNewContact: any
    • AudioNewContactReplyTone: any
    • AudioNewContactTone: any
    • AutoAccept: any
    • CXAFavAgents: any
    • CXAFavDigitalSkills: any
    • CXAFavExtDirectory: any
    • CXAFavInQuickRep: any
    • CXAFavNewGenDirectory: any
    • CXAFavOutQuickRep: any
    • CXAFavSkills: any
    • CXAFavStandAddBook: any
    • CXAFavStates: any
    • CXAFavTeams: any
    • CXARingtone: any
    • CXASecondaryDevice: any
    • CXASecondaryDeviceName: any
    • ExpandSoftphone: any
    • LoggingLevel: any
    • PageActionPopout: any
    • Panels: any
    • SecondaryDeviceDelay: any
    • SendOnEnter: any
    • Use24HourTime: any
    • VisualAgentMessage: any
    • VisualEndContact: any
    • VisualNewChat: any
    • VisualNewContact: any
    • emailMessageSortOrder: any
    • pinnedMenuItem: any
    • quickAppSequence: any
    • softPhoneVolume: any

mapperIncludingSearchAppSettings

  • mapperIncludingSearchAppSettings(currentClientDataObj: Record<string, unknown>, data: CXoneClientData): { AudioAgentMessage: any; AudioAgentMessageTone: any; AudioEndContact: any; AudioEndContactTone: any; AudioNewChat: any; AudioNewContact: any; AudioNewContactReplyTone: any; AudioNewContactTone: any; AutoAccept: any; CXAFavAgents: any; CXAFavDigitalSkills: any; CXAFavExtDirectory: any; CXAFavInQuickRep: any; CXAFavNewGenDirectory: any; CXAFavOutQuickRep: any; CXAFavSkills: any; CXAFavStandAddBook: any; CXAFavStates: any; CXAFavTeams: any; CXARingtone: any; CXASecondaryDevice: any; CXASecondaryDeviceName: any; CxaSearchAppSettings: unknown; ExpandSoftphone: any; LoggingLevel: any; PageActionPopout: any; Panels: any; SecondaryDeviceDelay: any; SendOnEnter: any; Use24HourTime: any; VisualAgentMessage: any; VisualEndContact: any; VisualNewChat: any; VisualNewContact: any; emailMessageSortOrder: any; pinnedMenuItem: any; quickAppSequence: any; softPhoneVolume: any }

  • Maps the provided CXoneClientData to the current client data object, including search app settings.

    example

    clientData.mapperIncludingSearchAppSettings(clientDataObj, data)

    Parameters

    • currentClientDataObj: Record<string, unknown>

      The current client data object to be updated.

    • data: CXoneClientData

      The new CXoneClientData containing updated settings.

    Returns { AudioAgentMessage: any; AudioAgentMessageTone: any; AudioEndContact: any; AudioEndContactTone: any; AudioNewChat: any; AudioNewContact: any; AudioNewContactReplyTone: any; AudioNewContactTone: any; AutoAccept: any; CXAFavAgents: any; CXAFavDigitalSkills: any; CXAFavExtDirectory: any; CXAFavInQuickRep: any; CXAFavNewGenDirectory: any; CXAFavOutQuickRep: any; CXAFavSkills: any; CXAFavStandAddBook: any; CXAFavStates: any; CXAFavTeams: any; CXARingtone: any; CXASecondaryDevice: any; CXASecondaryDeviceName: any; CxaSearchAppSettings: unknown; ExpandSoftphone: any; LoggingLevel: any; PageActionPopout: any; Panels: any; SecondaryDeviceDelay: any; SendOnEnter: any; Use24HourTime: any; VisualAgentMessage: any; VisualEndContact: any; VisualNewChat: any; VisualNewContact: any; emailMessageSortOrder: any; pinnedMenuItem: any; quickAppSequence: any; softPhoneVolume: any }

    An object containing the merged settings from the current client data object and the new data.

    • AudioAgentMessage: any
    • AudioAgentMessageTone: any
    • AudioEndContact: any
    • AudioEndContactTone: any
    • AudioNewChat: any
    • AudioNewContact: any
    • AudioNewContactReplyTone: any
    • AudioNewContactTone: any
    • AutoAccept: any
    • CXAFavAgents: any
    • CXAFavDigitalSkills: any
    • CXAFavExtDirectory: any
    • CXAFavInQuickRep: any
    • CXAFavNewGenDirectory: any
    • CXAFavOutQuickRep: any
    • CXAFavSkills: any
    • CXAFavStandAddBook: any
    • CXAFavStates: any
    • CXAFavTeams: any
    • CXARingtone: any
    • CXASecondaryDevice: any
    • CXASecondaryDeviceName: any
    • CxaSearchAppSettings: unknown
    • ExpandSoftphone: any
    • LoggingLevel: any
    • PageActionPopout: any
    • Panels: any
    • SecondaryDeviceDelay: any
    • SendOnEnter: any
    • Use24HourTime: any
    • VisualAgentMessage: any
    • VisualEndContact: any
    • VisualNewChat: any
    • VisualNewContact: any
    • emailMessageSortOrder: any
    • pinnedMenuItem: any
    • quickAppSequence: any
    • softPhoneVolume: any

parse

  • parse(data: {}): void

setSearchData

Generated using TypeDoc