你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
BeginComposeDocumentModelOptions interface
模型组合操作的选项。
- Extends
继承属性
abort |
可用于中止请求的信号。 |
description | 模型 (的文本说明可以是任何文本) 。 |
on |
一个可选的初始进度处理程序,将在轮询器状态更新时调用该处理程序。 初始化轮询器状态后,将立即调用此处理程序一次。 |
on |
在执行请求的操作时,每次从服务器收到响应时要调用的函数。 可以多次调用。 |
request |
创建和发送此操作的 HTTP 请求时使用的选项。 |
resume |
序列化的轮询程序状态。 如果提供,轮询操作将从给定状态恢复,而不是像新操作一样启动。 |
serializer |
用于替代序列化/反序列化行为的选项。 |
tags | 其他用户指定的键值对,作为永久性元数据与模型相关联。 |
tracing |
启用跟踪时使用的选项。 |
update |
与同一操作相关的后续请求之间) 等待 (的时间(以毫秒为单位)。 |
继承属性详细信息
abortSignal
可用于中止请求的信号。
abortSignal?: AbortSignalLike
属性值
description
onProgress
一个可选的初始进度处理程序,将在轮询器状态更新时调用该处理程序。 初始化轮询器状态后,将立即调用此处理程序一次。
onProgress?: (state: DocumentModelOperationState) => void
属性值
(state: DocumentModelOperationState) => void
onResponse
在执行请求的操作时,每次从服务器收到响应时要调用的函数。 可以多次调用。
onResponse?: RawResponseCallback
属性值
requestOptions
创建和发送此操作的 HTTP 请求时使用的选项。
requestOptions?: OperationRequestOptions
属性值
resumeFrom
序列化的轮询程序状态。 如果提供,轮询操作将从给定状态恢复,而不是像新操作一样启动。
resumeFrom?: string
属性值
string
serializerOptions
用于替代序列化/反序列化行为的选项。
serializerOptions?: SerializerOptions
属性值
tags
其他用户指定的键值对,作为永久性元数据与模型相关联。
tags?: Record<string, string>
属性值
Record<string, string>
tracingOptions
启用跟踪时使用的选项。
tracingOptions?: OperationTracingOptions
属性值
updateIntervalInMs
与同一操作相关的后续请求之间) 等待 (的时间(以毫秒为单位)。
updateIntervalInMs?: number
属性值
number