你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SimplePollerLike interface

包:

@azure-rest/maps-route

可用于轮询长时间运行的操作的简单轮询程序。

方法

getOperationState()	返回操作的状态。
getResult()	返回操作的结果值，而不考虑轮询器的状态。 它可以根据实现返回未定义或不完整的最终 TResult 值形式。
isDone()	如果轮询程序已完成轮询，则返回 true。
isStopped()	如果轮询器停止，则返回 true。
onProgress((state: TState) => void)	在每个轮询完成后调用提供的回调，并发送轮询程序操作的当前状态。 它返回一个方法，该方法可用于停止接收给定回调函数上的更新。
poll({ abortSignal?: AbortSignalLike })	返回一个承诺，该承诺将在单个轮询请求完成后解决。 它通过调用 Poller 操作的更新方法来执行此操作。
pollUntilDone({ abortSignal?: AbortSignalLike })	返回一个承诺，该承诺将在基础操作完成后解析。
serialize()	返回一个承诺，该承诺可用于通过调用操作的序列化方法序列化轮询程序操作的版本。
stopPolling()	阻止投票者继续轮询。 请注意，这只会停止客户端轮询
submitted()	等待投票器提交。
toString()	返回轮询器操作的字符串表示形式。 类似于序列化，但返回一个字符串。

方法详细信息

getOperationState()

返回操作的状态。

function getOperationState(): TState

返回

TState

getResult()

返回操作的结果值，而不考虑轮询器的状态。 它可以根据实现返回未定义或不完整的最终 TResult 值形式。

function getResult(): undefined | TResult

返回

undefined | TResult

isDone()

如果轮询程序已完成轮询，则返回 true。

function isDone(): boolean

返回

boolean

isStopped()

警告

现已弃用此 API。

Use abortSignal status to track this instead.

如果轮询器停止，则返回 true。

function isStopped(): boolean

返回

boolean

onProgress((state: TState) => void)

在每个轮询完成后调用提供的回调，并发送轮询程序操作的当前状态。

它返回一个方法，该方法可用于停止接收给定回调函数上的更新。

function onProgress(callback: (state: TState) => void): CancelOnProgress

参数

callback

(state: TState) => void

返回

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

返回一个承诺，该承诺将在单个轮询请求完成后解决。 它通过调用 Poller 操作的更新方法来执行此操作。

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>

参数

options

{ abortSignal?: AbortSignalLike }

返回

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

返回一个承诺，该承诺将在基础操作完成后解析。

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

参数

pollOptions

{ abortSignal?: AbortSignalLike }

返回

Promise<TResult>

serialize()

返回一个承诺，该承诺可用于通过调用操作的序列化方法序列化轮询程序操作的版本。

function serialize(): Promise<string>

返回

Promise<string>

stopPolling()

警告

现已弃用此 API。

Use abortSignal to stop polling instead.

阻止投票者继续轮询。 请注意，这只会停止客户端轮询

function stopPolling()

submitted()

等待投票器提交。

function submitted(): Promise<void>

返回

Promise<void>

toString()

警告

现已弃用此 API。

Use serialize() instead.

返回轮询器操作的字符串表示形式。 类似于序列化，但返回一个字符串。

function toString(): string

返回

string