BotState Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Definiuje obiekt zarządzania stanem i automatyzuje odczytywanie i zapisywanie skojarzonych właściwości stanu w warstwie magazynu.
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManager
type BotState = class
interface IPropertyManager
Public MustInherit Class BotState
Implements IPropertyManager
- Dziedziczenie
-
BotState
- Pochodne
- Implementuje
Uwagi
Każdy obiekt zarządzania stanem definiuje zakres warstwy pamięci.
Właściwości stanów są tworzone w ramach zakresu zarządzania stanem, a ramy bota definiują następujące zakresy: ConversationState, UserState, oraz PrivateConversationState.
Możesz zdefiniować dodatkowe zakresy dla swojego bota.
Konstruktory
| Nazwa | Opis |
|---|---|
| BotState(IStorage, String) |
Inicjuje nowe wystąpienie klasy BotState. |
Metody
| Nazwa | Opis |
|---|---|
| ClearStateAsync(ITurnContext, CancellationToken) |
Usuwa pamięć podręczną stanu dla tego BotState. |
| CreateProperty<T>(String) |
Tworzy nazwaną własność stanową w zakresie a BotState i zwraca przydział dla tej nieruchomości. |
| DeleteAsync(ITurnContext, CancellationToken) |
Usuwa każdy stan w pamięci oraz pamięć podręczną dla tego BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Usuwa właściwość z pamięci podręcznej stanu dla tego BotState. |
| Get(ITurnContext) |
Otrzymuje kopię surowych danych z tego kontekstu BotState tury. |
| GetCachedState(ITurnContext) |
Pobiera instancję stanu bota w pamięci podręcznej, która owija surowe dane buforowane do tego z BotState kontekstu tury. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Otrzymuje wartość właściwości z pamięci podręcznej stanu dla tego BotState. |
| GetStorageKey(ITurnContext) |
Po nadpisaniu w klasie pochodnej, otrzymuje klucz do odczytu i zapisu stanu do i z pamięci. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Wypełnia pamięć podręczną stanu dla tego BotState z warstwy pamięci. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Zapisuje pamięć podręczną stanu tego BotState stanu na warstwę pamięci. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Ustawia wartość właściwości w pamięci podręcznej stanu dla tego BotState. |