DurableEntityContext interface

套件:: durable-functions

提供實作實體作業的應用程式程式代碼功能。

屬性

entityId	取得目前執行中實體的標識碼。
entityKey	取得目前執行實體的索引鍵。
entityName	取得目前執行中實體的名稱。
isNewlyConstructed	此實體是否剛建構，亦即在呼叫此作業之前不存在。
operationName	取得呼叫之作業的名稱。實體上的作業調用包含作業名稱、指出要執行的作業，以及選擇性的作業輸入。

方法

destructOnExit()	完成此作業之後，會刪除此實體。
getInput<TInput>()	取得這項作業的輸入。實體上的作業調用包含作業名稱、指出要執行的作業，以及選擇性的作業輸入。
getState(() => TState)	取得這個實體的目前狀態，用於讀取和/或寫入。
return<TResult>(TResult)	將指定的結果傳回給這個作業的呼叫端。
setState(TState)	設定此實體的目前狀態。
signalEntity(EntityId, string, unknown)	發出實體執行作業的訊號，而不需等待回應。忽略任何結果或例外狀況（引發並忘記）。

屬性詳細資料

entityId

取得目前執行中實體的標識碼。

entityId: EntityId

屬性值

EntityId

entityKey

取得目前執行實體的索引鍵。

entityKey: string

屬性值

string

entityName

取得目前執行中實體的名稱。

entityName: string

屬性值

string

isNewlyConstructed

此實體是否剛建構，亦即在呼叫此作業之前不存在。

isNewlyConstructed: boolean

屬性值

boolean

operationName

取得呼叫之作業的名稱。

實體上的作業調用包含作業名稱、指出要執行的作業，以及選擇性的作業輸入。

operationName: undefined | string

屬性值

undefined | string

方法詳細資料

destructOnExit()

完成此作業之後，會刪除此實體。

function destructOnExit()

getInput<TInput>()

取得這項作業的輸入。

實體上的作業調用包含作業名稱、指出要執行的作業，以及選擇性的作業輸入。

function getInput<TInput>(): undefined | TInput

傳回

undefined | TInput

作業輸入，如果沒有，則為未定義。

getState(() => TState)

取得這個實體的目前狀態，用於讀取和/或寫入。

function getState(initializer?: () => TState): undefined | TState

參數

initializer: () => TState

提供用於狀態的初始值，而不是 TState 的預設值。

傳回

undefined | TState

此實體的目前狀態，如果尚未設定，則為未定義。

return<TResult>(TResult)

將指定的結果傳回給這個作業的呼叫端。

function return<TResult>(result: TResult)

參數

result: TResult

要傳回的結果。

setState(TState)

設定此實體的目前狀態。

function setState(state: TState)

參數

state: TState

實體的狀態。

signalEntity(EntityId, string, unknown)

發出實體執行作業的訊號，而不需等待回應。忽略任何結果或例外狀況（引發並忘記）。

function signalEntity(entity: EntityId, operationName: string, operationInput?: unknown)

參數

entity: EntityId

目標實體。

operationName: string

作業的名稱。

operationInput: unknown

作業輸入。