通过

BotStatePropertyAccessor class

  • 参考
包:
botbuilder-core

StatePropertyAccessor 接口的特定实现 BotState。

注解

可以使用 createProperty()为给定的 BotState 实例定义属性。

const dialogStateProperty = ConversationState.createProperty('dialogState');
const dialogs = new DialogSet(dialogStateProperty);

构造函数

BotStatePropertyAccessor(BotState, string)

创建新的 BotStatePropertyAccessor 实例。

属性

name

方法

delete(TurnContext)

从其后盾存储对象中删除持久化属性。
get(TurnContext)

从其后盾存储对象中读取持久属性。
get(TurnContext, T)
set(TurnContext, T)

为支持存储对象的属性分配新值。

构造函数详细信息

BotStatePropertyAccessor(BotState, string)

创建新的 BotStatePropertyAccessor 实例。

new BotStatePropertyAccessor(state: BotState, name: string)

参数

state
BotState

父 BotState 实例。

name

string

父 BotState 的属性的唯一名称。

属性详细信息

name 

name: string

属性值

string

方法详细信息

delete(TurnContext)

从其后盾存储对象中删除持久化属性。

function delete(context: TurnContext): Promise<void>

参数

context
TurnContext

（xref：botbuilder-core。此轮次的 TurnContext） 对象。

返回

Promise<void>

get(TurnContext)

从其后盾存储对象中读取持久属性。

function get(context: TurnContext): Promise<T | undefined>

参数

context
TurnContext

（xref：botbuilder-core。此轮次的 TurnContext） 对象。

返回

Promise<T | undefined>

缓存状态的 JSON 表示形式。

get(TurnContext, T) 

function get(context: TurnContext, defaultValue: T): Promise<T>

参数

context
TurnContext
defaultValue

T

返回

Promise<T>

set(TurnContext, T)

为支持存储对象的属性分配新值。

function set(context: TurnContext, value: T): Promise<void>

参数

context
TurnContext

（xref：botbuilder-core。此轮次的 TurnContext） 对象。

value

T

要在属性上设置的值。

返回

Promise<void>