BotStatePropertyAccessor class
BotState
StatePropertyAccessor
介面的特定實作。
備註
您可以使用 createProperty()
為指定的 BotState
實體定義屬性。
const dialogStateProperty = ConversationState.createProperty('dialogState');
const dialogs = new DialogSet(dialogStateProperty);
建構函式
Bot |
建立新的 BotStatePropertyAccessor 實例。 |
屬性
name |
方法
delete(Turn |
從其備份記憶體物件中刪除保存的屬性。 |
get(Turn |
從其備份記憶體物件讀取保存的屬性。 |
get(Turn |
|
set(Turn |
將新的值指派給備份記憶體物件的屬性。 |
建構函式詳細資料
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>