RouterWorker interface

Package:

@azure/communication-job-router

An entity for jobs to be routed to.

Properties

assignedJobs	A list of assigned jobs attached to this worker. NOTE: This property will not be serialized. It can only be populated by the server.
availableForOffers	A flag indicating this worker is open to receive offers or not.
channelConfigurations	The channel(s) this worker can handle and their impact on the workers capacity.
id	NOTE: This property will not be serialized. It can only be populated by the server.
labels	A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.
loadRatio	A value indicating the workers capacity. A value of '1' means all capacity is consumed. A value of '0' means no capacity is currently consumed. NOTE: This property will not be serialized. It can only be populated by the server.
offers	A list of active offers issued to this worker. NOTE: This property will not be serialized. It can only be populated by the server.
queueAssignments	The queue(s) that this worker can receive work from.
state	The current state of the worker. NOTE: This property will not be serialized. It can only be populated by the server.
tags	A set of non-identifying attributes attached to this worker.
totalCapacity	The total capacity score this worker has to manage multiple concurrent jobs.

Property Details

assignedJobs

A list of assigned jobs attached to this worker. NOTE: This property will not be serialized. It can only be populated by the server.

assignedJobs?: RouterWorkerAssignment[]

Property Value

RouterWorkerAssignment[]

availableForOffers

A flag indicating this worker is open to receive offers or not.

availableForOffers?: boolean

Property Value

boolean

channelConfigurations

The channel(s) this worker can handle and their impact on the workers capacity.

channelConfigurations?: {[propertyName: string]: ChannelConfiguration}

Property Value

{[propertyName: string]: ChannelConfiguration}

id

NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

labels

A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.

labels?: JSONObject

Property Value

JSONObject

loadRatio

A value indicating the workers capacity. A value of '1' means all capacity is consumed. A value of '0' means no capacity is currently consumed. NOTE: This property will not be serialized. It can only be populated by the server.

loadRatio?: number

Property Value

number

offers

A list of active offers issued to this worker. NOTE: This property will not be serialized. It can only be populated by the server.

offers?: RouterJobOffer[]

Property Value

RouterJobOffer[]

queueAssignments

The queue(s) that this worker can receive work from.

queueAssignments?: JSONObject

Property Value

JSONObject

state

The current state of the worker. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

tags

A set of non-identifying attributes attached to this worker.

tags?: JSONObject

Property Value

JSONObject

totalCapacity

The total capacity score this worker has to manage multiple concurrent jobs.

totalCapacity?: number

Property Value

number