DurableClient class

在此业务流程客户端实例上配置的任务中心的名称。

taskHubName: string

属性值

创建可用于检查指定实例状态的 HTTP 响应。

function createCheckStatusResponse(request: undefined | HttpRequest, instanceId: string): HttpResponse

参数

返回

包含 Location 标头和包含实例管理 URL 的有效负载的 HTTP 202 响应。

创建包含实例管理 HTTP 终结点的 HttpManagementPayload 对象。

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

参数

返回

获取指定业务流程实例的状态。

function getStatus(instanceId: string, options?: GetStatusOptions): Promise<DurableOrchestrationStatus>

参数

返回

获取所有业务流程实例的状态。

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

返回

获取与指定条件匹配的所有业务流程实例的状态。

function getStatusBy(filter: OrchestrationFilter): Promise<DurableOrchestrationStatus[]>

参数

返回

清除特定业务流程实例的历史记录。

function purgeInstanceHistory(instanceId: string): Promise<PurgeHistoryResult>

参数

返回

清除与条件匹配的实例的业务流程历史记录。

function purgeInstanceHistoryBy(filter: OrchestrationFilter): Promise<PurgeHistoryResult>

参数

返回

将事件通知消息发送到等待的业务流程实例。

function raiseEvent(instanceId: string, eventName: string, eventData: unknown, options?: TaskHubOptions): Promise<void>

参数

返回

一个承诺，用于在事件通知消息排队时解析。

若要处理事件，目标业务流程实例必须等待使用 eventName命名 waitForExternalEvent(string) 的事件。

如果未找到或未运行指定的实例，此作将不起作用。

尝试读取实体的当前状态。 如果实体不存在，或者实体的 JSON 序列化状态大于 16KB，则返回未定义。

function readEntityState<T>(entityId: EntityId, options?: TaskHubOptions): Promise<EntityStateResponse<T>>

参数

返回

包含实体的当前状态的响应。

以原因递减指定的失败业务流程实例。

function rewind(instanceId: string, reason: string, options?: TaskHubOptions): Promise<void>

参数

返回

一个承诺，用于在卷入回退消息时解析。

此功能目前以预览版提供。

向实体发出执行作的信号。

function signalEntity(entityId: EntityId, operationName?: string, operationContent?: unknown, options?: TaskHubOptions): Promise<void>

参数

返回

启动指定业务流程协调程序函数的新实例。

如果已存在具有指定 ID 的业务流程实例，则现有实例将被此新实例以无提示方式替换。

function startNew(orchestratorFunctionName: string, options?: StartNewOptions): Promise<string>

参数

返回

新业务流程实例的 ID。

终止正在运行的业务流程实例。

function terminate(instanceId: string, reason: string): Promise<void>

参数

返回

一个承诺，用于在终止消息排队时解析。

终止业务流程实例不会影响当前业务流程实例启动的任何正在进行的活动函数执行或子业务流程。

创建一个 HTTP 响应，该响应包含非已完成实例的管理 URL 的有效负载，或包含包含已完成业务流程输出的有效负载。

如果业务流程未在指定的超时范围内完成，则 HTTP 响应将与 createCheckStatusResponse（） 的响应相同。

function waitForCompletionOrCreateCheckStatusResponse(request: HttpRequest, instanceId: string, waitOptions?: WaitForCompletionOptions): Promise<HttpResponse>

参数

返回