BotSignIn.GetSignInUrlWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Bot.Connector

Assembly:: Microsoft.Bot.Connector.dll

Package:: Microsoft.Bot.Connector 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.

Gets sign-in URL with HTTP message.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<string>> GetSignInUrlWithHttpMessagesAsync (string state, string codeChallenge = default, string emulatorUrl = default, string finalRedirect = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSignInUrlWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<string>>
override this.GetSignInUrlWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<string>>

Public Function GetSignInUrlWithHttpMessagesAsync (state As String, Optional codeChallenge As String = Nothing, Optional emulatorUrl As String = Nothing, Optional finalRedirect As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of String))

Parameters

state: String

State.

codeChallenge: String

Code challenge.

emulatorUrl: String

Emulator URL.

finalRedirect: String

Final redirect.

customHeaders: Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<Microsoft.Rest.HttpOperationResponse<String>>

A response object containing the response body and response headers.

Implements

GetSignInUrlWithHttpMessagesAsync(String, String, String, String, Dictionary<String,List<String>>, CancellationToken)

Exceptions

Microsoft.Rest.HttpOperationException

Thrown when the operation returned an invalid status code.

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response.

Microsoft.Rest.ValidationException

Thrown when an input value does not match the expected data type, range or pattern of the data field.

ArgumentNullException

Thrown when a required parameter is null.

Applies to