BotFrameworkAdapter.SignOutUserAsync Method

Definition

Namespace:

Microsoft.Bot.Builder

Assembly:

Microsoft.Bot.Builder.dll

Package:

Microsoft.Bot.Builder v4.18.1

Overloads

SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Signs the user out with the token server, using the bot's AppCredentials.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Signs the user out with the token server, using customized AppCredentials.

SignOutUserAsync(ITurnContext, String, String, CancellationToken)

Signs the user out with the token server, using the bot's AppCredentials.

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

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

Public Overridable Function SignOutUserAsync (turnContext As ITurnContext, Optional connectionName As String = Nothing, Optional userId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

turnContext

ITurnContext

Context for the current turn of conversation with the user.

connectionName

String

Name of the auth connection to use.

userId

String

User id of user to sign out.

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.

Implements

SignOutUserAsync(ITurnContext, String, String, CancellationToken)

SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)

Signs the user out with the token server, using customized AppCredentials.

public virtual System.Threading.Tasks.Task SignOutUserAsync (Microsoft.Bot.Builder.ITurnContext turnContext, Microsoft.Bot.Connector.Authentication.AppCredentials oAuthAppCredentials, string connectionName = default, string userId = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SignOutUserAsync : Microsoft.Bot.Builder.ITurnContext * Microsoft.Bot.Connector.Authentication.AppCredentials * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.SignOutUserAsync : Microsoft.Bot.Builder.ITurnContext * Microsoft.Bot.Connector.Authentication.AppCredentials * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function SignOutUserAsync (turnContext As ITurnContext, oAuthAppCredentials As AppCredentials, Optional connectionName As String = Nothing, Optional userId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

turnContext

ITurnContext

Context for the current turn of conversation with the user.

oAuthAppCredentials

AppCredentials

AppCredentials for OAuth.

connectionName

String

Name of the auth connection to use.

userId

String

User id of user to sign out.

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.

Implements

SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)