TestAdapter.SignOutUserAsync 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.
Overloads
SignOutUserAsync(ITurnContext, String, String, CancellationToken) |
Signs a user out by removing the user's token(s) from mock storage, using the bot's app credentials. |
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Signs a user out by remove the user's token(s) from mock storage, using customized AppCredentials. |
SignOutUserAsync(ITurnContext, String, String, CancellationToken)
Signs a user out by removing the user's token(s) from mock storage, using the bot's app credentials.
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
The turnContext (with a valid activity).
- connectionName
- String
The connection name.
- userId
- String
The user ID.
- cancellationToken
- CancellationToken
The Task cancellation token.
Returns
None.
Implements
Applies to
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)
Signs a user out by remove the user's token(s) from mock storage, 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
The turnContext (with a valid Activity).
- oAuthAppCredentials
- AppCredentials
The app credentials for OAuth.
- connectionName
- String
The connection name.
- userId
- String
The user ID.
- cancellationToken
- CancellationToken
The Task cancellation token.
Returns
None.