BotState Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Definierar ett tillståndshanteringsobjekt och automatiserar läsning och skrivning av associerade tillståndsegenskaper till ett lagringslager.
public abstract class BotState : Microsoft.Bot.Builder.IPropertyManagertype BotState = class
interface IPropertyManagerPublic MustInherit Class BotState
Implements IPropertyManager- Arv
-
BotState
- Härledda
- Implementeringar
Kommentarer
Varje tillståndshanteringsobjekt definierar ett område för ett lagringslager.
Tillståndsegenskaper skapas inom ett tillståndshanteringsområde, och Bot Framework definierar dessa områden: ConversationState, UserState, och PrivateConversationState.
Du kan definiera ytterligare scopes för din bot.
Konstruktorer
| Name | Description |
|---|---|
| BotState(IStorage, String) |
Initierar en ny instans av BotState klassen. |
Metoder
| Name | Description |
|---|---|
| ClearStateAsync(ITurnContext, CancellationToken) |
Rensar tillståndscachen för detta BotState. |
| CreateProperty<T>(String) |
Skapar en namngiven statsegendom inom ramen för en BotState och returnerar en accessor för egendomen. |
| DeleteAsync(ITurnContext, CancellationToken) |
Tar bort alla tillstånd i lagringen och cachen för detta BotState. |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Tar bort en egenskap från tillståndscachen för detta BotState. |
| Get(ITurnContext) |
Får en kopia av råcachad data för detta BotState från tur-kontexten. |
| GetCachedState(ITurnContext) |
Hämtar den cachade botens tillståndsinstans som omsluter den råa cachad datan för detta BotState från turn-kontexten. |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Får värdet av en egenskap från tillståndscachen för denna BotState. |
| GetStorageKey(ITurnContext) |
När den överskrivs i en härledd klass, får nyckeln att använda när man läser och skriver tillstånd till och från lagring. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Fyller på tillståndscachen för detta BotState från lagringslagret. |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Skriver statuscachen för detta BotState till lagringslagret. |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Sätter värdet på en egenskap i tillståndscachen för denna BotState. |