IWebAuthenticator.AuthenticateAsync Method

Definition

Namespace:: Microsoft.Maui.Authentication

Assembly:: Microsoft.Maui.Essentials.dll

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

Name	Description
AuthenticateAsync(WebAuthenticatorOptions)	Begin an authentication flow by navigating to the specified URL and waiting for a callback/redirect to the callback URL scheme.
AuthenticateAsync(WebAuthenticatorOptions, CancellationToken)	Begin an authentication flow by navigating to the specified URL and waiting for a callback/redirect to the callback URL scheme, with cancellation support.

AuthenticateAsync(WebAuthenticatorOptions)

Source:: WebAuthenticator.shared.cs

Source:: WebAuthenticator.shared.cs

Source:: WebAuthenticator.shared.cs

Source:: WebAuthenticator.shared.cs

Begin an authentication flow by navigating to the specified URL and waiting for a callback/redirect to the callback URL scheme.

public:
 System::Threading::Tasks::Task<Microsoft::Maui::Authentication::WebAuthenticatorResult ^> ^ AuthenticateAsync(Microsoft::Maui::Authentication::WebAuthenticatorOptions ^ webAuthenticatorOptions);

public System.Threading.Tasks.Task<Microsoft.Maui.Authentication.WebAuthenticatorResult> AuthenticateAsync(Microsoft.Maui.Authentication.WebAuthenticatorOptions webAuthenticatorOptions);

abstract member AuthenticateAsync : Microsoft.Maui.Authentication.WebAuthenticatorOptions -> System.Threading.Tasks.Task<Microsoft.Maui.Authentication.WebAuthenticatorResult>

Public Function AuthenticateAsync (webAuthenticatorOptions As WebAuthenticatorOptions) As Task(Of WebAuthenticatorResult)

Parameters

webAuthenticatorOptions: WebAuthenticatorOptions

A WebAuthenticatorOptions instance containing additional configuration for this authentication call.

Returns

Task<WebAuthenticatorResult>

A WebAuthenticatorResult object with the results of this operation.

Exceptions

HttpRequestException

Windows: Thrown when a HTTP Request error occured.

Exception

Windows: Thrown when a unexpected HTTP response was received.

PlatformNotSupportedException

Windows: Thrown when called on Windows.

TaskCanceledException

Thrown when the user canceled the authentication flow.

FeatureNotSupportedException

iOS/macOS: Thrown when iOS version is less than 13 is used or macOS less than 13.1 is used.

InvalidOperationException

Android: Thrown when the no IntentFilter has been created for the callback URL.

Windows: Thrown when the callback URL is invalid, its protocol is not registered, the browser cannot be launched, or another app instance is already waiting for the callback scheme.

Applies to

AuthenticateAsync(WebAuthenticatorOptions, CancellationToken)

Source:: WebAuthenticator.shared.cs

Source:: WebAuthenticator.shared.cs

Begin an authentication flow by navigating to the specified URL and waiting for a callback/redirect to the callback URL scheme, with cancellation support.

public:
 System::Threading::Tasks::Task<Microsoft::Maui::Authentication::WebAuthenticatorResult ^> ^ AuthenticateAsync(Microsoft::Maui::Authentication::WebAuthenticatorOptions ^ webAuthenticatorOptions, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<Microsoft.Maui.Authentication.WebAuthenticatorResult> AuthenticateAsync(Microsoft.Maui.Authentication.WebAuthenticatorOptions webAuthenticatorOptions, System.Threading.CancellationToken cancellationToken);

abstract member AuthenticateAsync : Microsoft.Maui.Authentication.WebAuthenticatorOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Maui.Authentication.WebAuthenticatorResult>

Public Function AuthenticateAsync (webAuthenticatorOptions As WebAuthenticatorOptions, cancellationToken As CancellationToken) As Task(Of WebAuthenticatorResult)