ListWorkersOptions interface

Paket:

@azure/communication-job-router

Alternativ för att lista arbetare.

Extends

OperationOptions

Egenskaper

channelId	(Valfritt) Om det anges väljer du arbetare som har en kanalkonfiguration med den här kanalen
hasCapacity	(Valfritt) Om det är sant väljer du arbetare som har kapacitet för den kanal som anges av channelId (vilken kanal som helst om channelId den inte har angetts). Om det är falskt påverkar det inte listans beteende. Standardvärdet är falskt.
maxPageSize	Antal objekt som ska returneras per sida
queueId	(Valfritt) Om det anges väljer du arbetare som är tilldelade till den här kön
status	(Valfritt) Om du anger det väljer du arbetare efter arbetsstatus.

Ärvda egenskaper

abortSignal	Den signal som kan användas för att avbryta begäranden.
onResponse	En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
requestOptions	Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
serializerOptions	Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.
tracingOptions	Alternativ som används när spårning är aktiverat.

Egenskapsinformation

channelId

(Valfritt) Om det anges väljer du arbetare som har en kanalkonfiguration med den här kanalen

channelId?: string

Egenskapsvärde

string

hasCapacity

(Valfritt) Om det är sant väljer du arbetare som har kapacitet för den kanal som anges av channelId (vilken kanal som helst om channelId den inte har angetts). Om det är falskt påverkar det inte listans beteende. Standardvärdet är falskt.

hasCapacity?: boolean

Egenskapsvärde

boolean

maxPageSize

Antal objekt som ska returneras per sida

maxPageSize?: number

Egenskapsvärde

number

queueId

(Valfritt) Om det anges väljer du arbetare som är tilldelade till den här kön

queueId?: string

Egenskapsvärde

string

status

(Valfritt) Om du anger det väljer du arbetare efter arbetsstatus.

status?: string

Egenskapsvärde

string

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

Ärvd från OperationOptions.abortSignal

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

RawResponseCallback

Ärvd från OperationOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

OperationRequestOptions

Ärvd från OperationOptions.requestOptions

serializerOptions

Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.

serializerOptions?: SerializerOptions

Egenskapsvärde

SerializerOptions

ärvd från OperationOptions.serializerOptions

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

Ärvd från OperationOptions.tracingOptions