DurableClient class

在此協調流程用戶端實例上設定的工作中樞名稱。

taskHubName: string

屬性值

建立用於檢查指定實例狀態的 HTTP 回應。

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

參數

傳回

具有 Location 標頭的 HTTP 202 回應，以及包含實例管理 URL 的承載。

建立包含實例管理 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>

參數

傳回

啟動指定協調器函式的新實例。

如果已存在具有指定標識符的協調流程實例，現有的實例將會以無訊息方式取代這個新實例。

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

參數

傳回

新協調流程實例的標識碼。

終止執行中的協調流程實例。

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

參數

傳回

在佇列終止訊息時解析的承諾。

終止協調流程實例不會影響目前協調流程實例啟動的任何即時活動函式執行或子協調流程。

建立 HTTP 回應，其中包含非已完成實例的管理 URL 承載，或包含包含已完成協調流程輸出的承載。

如果協調流程未在指定的逾時內完成，則 HTTP 回應會與 createCheckStatusResponse（） 的回應相同。

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

參數

傳回