Class AgentLegEvent

Model class for Agent leg event

Hierarchy

CXoneAgentEvent
- AgentLegEvent

Index

Constructors

constructor

Properties

Methods

parse

Constructors

constructor

new AgentLegEvent(): AgentLegEvent

Inherited from CXoneAgentEvent.constructor
Returns AgentLegEvent

Properties

agentLegId

agentLegId: string

remarks

The 'contact ID' for the agent leg script. This can be helpful in situations where a single app is managing multiple agent sessions. This ID will be valid from the time the agent leg is 'dialing', until it is disconnected

finalState

finalState: boolean

remarks

Indicates whether the state is the final state for the agent leg "contact". This will only be "true" for the "Disconnected" status event.

iisHost

iisHost: string

iis hosting event details

status

status: AgentLegStatus

remarks

The status of the agent leg. Will be 'Dialing', 'Active', or 'Disconnected'.

vcHost

vcHost: string

vc hosting event details

Methods

parse

parse(data: {}): void

Overrides CXoneAgentEvent.parse
- Defined in common-sdk/src/lib/model/agent/agent-leg-event.ts:36
The parse method will take the data object and assign the values to the agentLeg class properties
example
```
parse(data);
```
Parameters
- data: {}
  
  Data object received
  - [key: string]: string
Returns void

Generated using TypeDoc