Share via


BotFrameworkAdapter.GetSignInResourceAsync Method

Definition

Overloads

GetSignInResourceAsync(ITurnContext, String, CancellationToken)

Get the raw signin link to be sent to the user for signin for a connection name.

GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)

Get the raw signin link to be sent to the user for signin for a connection name.

GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)

Get the raw signin link to be sent to the user for signin for a connection name.

GetSignInResourceAsync(ITurnContext, String, CancellationToken)

Get the raw signin link to be sent to the user for signin for a connection name.

public virtual System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource> GetSignInResourceAsync (Microsoft.Bot.Builder.ITurnContext turnContext, string connectionName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSignInResourceAsync : Microsoft.Bot.Builder.ITurnContext * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource>
override this.GetSignInResourceAsync : Microsoft.Bot.Builder.ITurnContext * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource>
Public Overridable Function GetSignInResourceAsync (turnContext As ITurnContext, connectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SignInResource)

Parameters

turnContext
ITurnContext

Context for the current turn of conversation with the user.

connectionName
String

Name of the auth connection to use.

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.

Implements

Remarks

If the task completes successfully, the result contains the raw signin link.

Applies to

GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)

Get the raw signin link to be sent to the user for signin for a connection name.

public virtual System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource> GetSignInResourceAsync (Microsoft.Bot.Builder.ITurnContext turnContext, string connectionName, string userId, string finalRedirect = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSignInResourceAsync : Microsoft.Bot.Builder.ITurnContext * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource>
override this.GetSignInResourceAsync : Microsoft.Bot.Builder.ITurnContext * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource>
Public Overridable Function GetSignInResourceAsync (turnContext As ITurnContext, connectionName As String, userId As String, Optional finalRedirect As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SignInResource)

Parameters

turnContext
ITurnContext

Context for the current turn of conversation with the user.

connectionName
String

Name of the auth connection to use.

userId
String

The user id that will be associated with the token.

finalRedirect
String

The final URL that the OAuth flow will redirect to.

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.

Implements

Remarks

If the task completes successfully, the result contains the raw signin link.

Applies to

GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)

Get the raw signin link to be sent to the user for signin for a connection name.

public virtual System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource> GetSignInResourceAsync (Microsoft.Bot.Builder.ITurnContext turnContext, Microsoft.Bot.Connector.Authentication.AppCredentials oAuthAppCredentials, string connectionName, string userId, string finalRedirect = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSignInResourceAsync : Microsoft.Bot.Builder.ITurnContext * Microsoft.Bot.Connector.Authentication.AppCredentials * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource>
override this.GetSignInResourceAsync : Microsoft.Bot.Builder.ITurnContext * Microsoft.Bot.Connector.Authentication.AppCredentials * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.SignInResource>
Public Overridable Function GetSignInResourceAsync (turnContext As ITurnContext, oAuthAppCredentials As AppCredentials, connectionName As String, userId As String, Optional finalRedirect As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SignInResource)

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

The user id that will be associated with the token.

finalRedirect
String

The final URL that the OAuth flow will redirect to.

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.

Implements

Remarks

If the task completes successfully, the result contains the raw signin link.

Applies to