ActivityHandler.OnSignInInvokeAsync Method

Reference

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v4.18.1

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.

Invoked when a signin/verifyState or signin/tokenExchange event is received when the base behavior of OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) is used. If using an OAuthPrompt, override this method to forward this Activity to the current dialog. By default, this method does nothing.

protected virtual System.Threading.Tasks.Task OnSignInInvokeAsync (Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.IInvokeActivity> turnContext, System.Threading.CancellationToken cancellationToken);

abstract member OnSignInInvokeAsync : Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.IInvokeActivity> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.OnSignInInvokeAsync : Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.IInvokeActivity> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected Overridable Function OnSignInInvokeAsync (turnContext As ITurnContext(Of IInvokeActivity), cancellationToken As CancellationToken) As Task

Parameters

turnContext: ITurnContext<IInvokeActivity>

A strongly-typed 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.

Remarks

When the OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) method receives an Invoke with a Name of `tokens/response`, it calls this method.

If your bot uses the OAuthPrompt, forward the incoming Activity to the current dialog.

Applies to