你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

作输入。