BotStatePropertyAccessor class
BotState
конкретную реализацию интерфейса StatePropertyAccessor
.
Комментарии
Свойства можно определить для данного экземпляра BotState
с помощью createProperty()
.
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>