AgentState.DeleteStateAsync(ITurnContext, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Deletes state in storage.
public virtual System.Threading.Tasks.Task DeleteStateAsync(Microsoft.Agents.Builder.ITurnContext turnContext, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteStateAsync : Microsoft.Agents.Builder.ITurnContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteStateAsync : Microsoft.Agents.Builder.ITurnContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function DeleteStateAsync (turnContext As ITurnContext, Optional cancellationToken As CancellationToken = Nothing) As Task
Parameters
- turnContext
- ITurnContext
The context object for this turn.
- cancellationToken
- CancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
A task that represents the work queued to execute.