IUserTokenProvider.GetOauthSignInLinkAsync 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
| GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken) |
Get the raw signin link to be sent to the user for signin for a connection name, using the bot's AppCredentials. |
| GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken) |
Get the raw signin link to be sent to the user for signin for a connection name, using the bot's AppCredentials. |
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)
Get the raw signin link to be sent to the user for signin for a connection name, using the bot's AppCredentials.
public System.Threading.Tasks.Task<string> GetOauthSignInLinkAsync (Microsoft.Bot.Builder.ITurnContext turnContext, string connectionName, System.Threading.CancellationToken cancellationToken);abstract member GetOauthSignInLinkAsync : Microsoft.Bot.Builder.ITurnContext * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>Public Function GetOauthSignInLinkAsync (turnContext As ITurnContext, connectionName As String, cancellationToken As CancellationToken) As Task(Of String)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.
Remarks
If the task completes successfully, the result contains the raw signin link.
Applies to
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)
Get the raw signin link to be sent to the user for signin for a connection name, using the bot's AppCredentials.
public System.Threading.Tasks.Task<string> GetOauthSignInLinkAsync (Microsoft.Bot.Builder.ITurnContext turnContext, string connectionName, string userId, string finalRedirect = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetOauthSignInLinkAsync : Microsoft.Bot.Builder.ITurnContext * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>Public Function GetOauthSignInLinkAsync (turnContext As ITurnContext, connectionName As String, userId As String, Optional finalRedirect As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)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.
Remarks
If the task completes successfully, the result contains the raw signin link.