DurableEntityContext interface

パッケージ:

durable-functions

エンティティ操作を実装するアプリケーション コードの機能を提供します。

プロパティ

entityId	現在実行中のエンティティの ID を取得します。
entityKey	現在実行中のエンティティのキーを取得します。
entityName	現在実行中のエンティティの名前を取得します。
isNewlyConstructed	このエンティティが新しく構築されているかどうか、つまり、この操作が呼び出される前に存在しませんでした。
operationName	呼び出された操作の名前を取得します。 エンティティに対する操作呼び出しには、実行する操作を示す操作名と、必要に応じて操作入力が含まれます。

メソッド

destructOnExit()	この操作が完了した後、このエンティティを削除します。
getInput<TInput>()	この操作の入力を取得します。 エンティティに対する操作呼び出しには、実行する操作を示す操作名と、必要に応じて操作入力が含まれます。
getState(() => TState)	読み取りまたは書き込みのために、このエンティティの現在の状態を取得します。
return<TResult>(TResult)	指定した結果をこの操作の呼び出し元に返します。
setState(TState)	このエンティティの現在の状態を設定します。
signalEntity(EntityId, string, unknown)	応答を待たずに、操作を実行するようにエンティティに通知します。 結果または例外は無視されます (起動と忘れ)。

プロパティの詳細

entityId

現在実行中のエンティティの ID を取得します。

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

操作の入力。