InspectionState Class

Definition

Namespace:

Microsoft.Bot.Builder

Assembly:

Microsoft.Bot.Builder.dll

Package:

Microsoft.Bot.Builder v4.18.1

Caution

This class is obsolete and will be removed in a future version of the framework.

A state management object that automates the reading and writing of the associated state properties to a storage layer. Used by Inspection middleware that enables debugging bot state.

[System.Obsolete("This class is obsolete and will be removed in a future version of the framework.", false)]
public class InspectionState : Microsoft.Bot.Builder.BotState

[<System.Obsolete("This class is obsolete and will be removed in a future version of the framework.", false)>]
type InspectionState = class
    inherit BotState

Public Class InspectionState
Inherits BotState

Inheritance

Object

BotState

InspectionState

Attributes

ObsoleteAttribute

Constructors

InspectionState(IStorage)

Initializes a new instance of the InspectionState class.

Methods

ClearStateAsync(ITurnContext, CancellationToken)	Clears the state cache for this BotState. (Inherited from BotState)
CreateProperty<T>(String)	Creates a named state property within the scope of a BotState and returns an accessor for the property. (Inherited from BotState)
DeleteAsync(ITurnContext, CancellationToken)	Deletes any state in storage and the cache for this BotState. (Inherited from BotState)
DeletePropertyValueAsync(ITurnContext, String, CancellationToken)	Deletes a property from the state cache for this BotState. (Inherited from BotState)
Get(ITurnContext)	Gets a copy of the raw cached data for this BotState from the turn context. (Inherited from BotState)
GetCachedState(ITurnContext)	Gets the cached bot state instance that wraps the raw cached data for this BotState from the turn context. (Inherited from BotState)
GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken)	Gets the value of a property from the state cache for this BotState. (Inherited from BotState)
GetStorageKey(ITurnContext)	Gets the key to use when reading and writing state to and from storage.
LoadAsync(ITurnContext, Boolean, CancellationToken)	Populates the state cache for this BotState from the storage layer. (Inherited from BotState)
SaveChangesAsync(ITurnContext, Boolean, CancellationToken)	Writes the state cache for this BotState to the storage layer. (Inherited from BotState)
SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken)	Sets the value of a property in the state cache for this BotState. (Inherited from BotState)