StatePropertyAccessor interface
定義方法，以存取 BotState 物件中建立的狀態屬性。
備註
若要在狀態管理 objet 中建立狀態屬性，請使用createProperty < T >方法。
方法
| delete(Turn |
從其備份儲存體物件中刪除保存的屬性。 |
| get(Turn |
從其備份儲存體物件讀取保存的屬性。 |
| get(Turn |
|
| set(Turn |
將新值指派給備份儲存物件的屬性。 |
方法詳細資料
delete(TurnContext)
從其備份儲存體物件中刪除保存的屬性。
function delete(context: TurnContext): Promise<void>參數
- context
- TurnContext
與使用者交談目前回合的內容。
傳回
Promise<void>
備註
備份儲存體物件的屬性應該在第一次存取時載入記憶體中。
await myProperty.delete(context);
get(TurnContext)
從其備份儲存體物件讀取保存的屬性。
function get(context: TurnContext): Promise<T | undefined>參數
- context
- TurnContext
與使用者交談目前回合的內容。
傳回
Promise<T | undefined>
備註
備份儲存體物件的屬性應該在第一次存取時載入記憶體中。
如果屬性目前不存在於儲存體物件上，而且 defaultValue 已指定 ，則應該將 的複本 defaultValue 複製到儲存體物件。
defaultValue如果未指定 ，則會傳回 SHOULD 的值 undefined 。
const value = await myProperty.get(context, { count: 0 });
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
與使用者交談目前回合的內容。
- value
-
T
要指派的值。
傳回
Promise<void>
備註
備份儲存體物件的屬性應該在第一次存取時載入記憶體中。
視狀態系統實作而定，可能需要額外的步驟，才能將實際變更保存到磁片。
await myProperty.set(context, value);