Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CXoneWorkItemContact

update the class properties for work item

param workItemEvent

work item event

example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional acwTypeId

acwTypeId?: number
remarks
  • represent model for ACW Type Id value

contactID

contactID: string
remarks
  • 'contactID' is identifier for the ACD contacts only. For DFO Contact please refer 'caseID' property in CXoneDigitalContact

Private contactService

contactService: ContactService = ...

finalState

finalState: boolean
remarks
  • represent model for final state

Optional fromProvider

fromProvider?: string
remarks
  • represent model for denoting type of parent interaction while elevating

interactionId

interactionId: string
remarks
  • represent model for interaction id

lastStateChangeTime

lastStateChangeTime: Date
remarks
  • represent model for last state change time

Optional maxSecondsACW

maxSecondsACW?: number
remarks
  • represent model for max seconds ACW

Optional requireDisposition

requireDisposition?: boolean
remarks
  • represent model for require disposition value

skill

skill: string
remarks
  • represent model for contact skill

skillName

skillName: string
remarks
  • represent model for skill name

startTime

startTime: Date
remarks
  • represent model for start time

status

status: string
remarks
  • represent model for contact status

type

type: string
remarks
  • represent model for contact type

workItemEventData

workItemEventData: 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> }>

Methods

complete

  • function that will call the end contact endpoint for the work item

    example
    • complete()

    Returns Promise<HttpResponse | CXoneSdkError>

transfer

  • Method to transfer a work item contact.

    example
    transfer('agentUserName');

    Parameters

    • agentUserName: string

      username of the agent that will receive the transferred contact

    Returns Promise<HttpResponse | CXoneSdkError>

Private updateCurrentWorkitemInfo

  • updateCurrentWorkitemInfo(workItemInfo: 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> }>): void
  • example

    Parameters

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

    Returns void

updateWorkitemControls

  • updateWorkitemControls(workItemEvent?: 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> }>): void
  • example

    Parameters

    • Optional workItemEvent: 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> }>

    Returns void

Generated using TypeDoc