1. References
  2. VoxEngine
  3. SmartQueueTask
Rate this page:

SmartQueueTask

Methods

addEventListener

Copy URL
addEventListener(event: 
SmartQueueEvents
, callback: 
Function
): 
void

Adds a handler for the specified SmartQueueEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler will be called

Parameters

  • event:

    SmartQueueEvents

    Event class (i.e., [SmartQueueEvents.EnqueueSuccess])

  • callback:

    Function

    Handler function. A single parameter is passed - object with event information

Returns

  • type:

    void

end

Copy URL
end(description: 
string
): 
void

Ends the current activity.

Parameters

  • description:

    string

Returns

  • type:

    void

removeEventListener

Copy URL
removeEventListener(event: 
SmartQueueEvents
, callback: 
Function
): 
void

Removes a handler for the specified SmartQueueEvents event

Parameters

  • event:

    SmartQueueEvents

    Event class (i.e., [SmartQueueEvents.EnqueueSuccess])

  • callback:

    Function

    Optional

    Handler function. If not specified, all event listeners are removed

Returns

  • type:

    void

Props

id

Copy URL
id: 
string

A Smart queue activity's ID.

operatorCall

Copy URL
operatorCall: 
Call
 | 
null

The operator's Call object.

settings

Copy URL
settings: 
SmartQueueTaskSettings

Specifies the smart queue activity's settings, such as required skills, priority, queue and more.

status

Copy URL
status: 
SmartQueueTaskStatus

Specifies the current status of the activity, whether it is distributing, connecting, connected, ended or failed.

taskCall

Copy URL
taskCall: 
Call

The activity's Call object.

terminationStatus

Copy URL
terminationStatus: 
TerminationStatus
 | 
null

Specifies the reason of activity's termination.