ListWorkersOptions interface

包:

@azure/communication-job-router

列出工作人员的选项。

扩展

OperationOptions

属性

channelId	（可选）如果指定，请选择具有此通道配置的辅助角色
hasCapacity	（可选）如果为 true，则选择具有 所 channelId 指定通道容量的工作人员（如果未指定任何 channelId 通道）。 如果为 false，则不会影响列表行为。 默认值为 false。
maxPageSize	每页要返回的对象数
queueId	（可选）如果指定，请选择分配给此队列的辅助角色
status	（可选）如果指定，则按辅助角色状态选择辅助角色。

继承属性

abortSignal	可用于中止请求的信号。
onResponse	在执行请求的操作时，每次从服务器接收响应时调用的函数。 可以多次调用。
requestOptions	为此操作创建和发送 HTTP 请求时使用的选项。
serializerOptions	用于替代序列化/取消序列化行为的选项。
tracingOptions	启用跟踪时使用的选项。

属性详细信息

channelId

（可选）如果指定，请选择具有此通道配置的辅助角色

channelId?: string

属性值

string

hasCapacity

（可选）如果为 true，则选择具有 所 channelId 指定通道容量的工作人员（如果未指定任何 channelId 通道）。 如果为 false，则不会影响列表行为。 默认值为 false。

hasCapacity?: boolean

属性值

boolean

maxPageSize

每页要返回的对象数

maxPageSize?: number

属性值

number

queueId

（可选）如果指定，请选择分配给此队列的辅助角色

queueId?: string

属性值

string

status

（可选）如果指定，则按辅助角色状态选择辅助角色。

status?: string

属性值

string

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 OperationOptions.abortSignal 的

onResponse

在执行请求的操作时，每次从服务器接收响应时调用的函数。 可以多次调用。

onResponse?: RawResponseCallback

属性值

RawResponseCallback

继承自 OperationOptions.onResponse

requestOptions

为此操作创建和发送 HTTP 请求时使用的选项。

requestOptions?: OperationRequestOptions

属性值

OperationRequestOptions

继承自 OperationOptions.requestOptions

serializerOptions

用于替代序列化/取消序列化行为的选项。

serializerOptions?: SerializerOptions

属性值

SerializerOptions

继承自 OperationOptions.serializerOptions

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自 OperationOptions.tracingOptions