BotState.DeleteAsync(ITurnContext, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v4.22.7

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 any state in storage and the cache for this BotState.

public virtual System.Threading.Tasks.Task DeleteAsync (Microsoft.Bot.Builder.ITurnContext turnContext, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAsync : Microsoft.Bot.Builder.ITurnContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteAsync : Microsoft.Bot.Builder.ITurnContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DeleteAsync (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

Task

A task that represents the work queued to execute.

Exceptions

ArgumentNullException

turnContext is null.

Applies to

Jaa