IWebAuthenticator.AuthenticateAsync(WebAuthenticatorOptions) Method

Reference

Definition

Namespace:: Microsoft.Maui.Authentication

Assembly:: Microsoft.Maui.Essentials.dll

Source:: WebAuthenticator.shared.cs

Source:: WebAuthenticator.shared.cs

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.

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

TaskCanceledException

Thrown when the user canceled the authentication flow.

HttpRequestException

Windows: Thrown when a HTTP Request error occured.

Exception

Windows: Thrown when a unexpected HTTP response was received.

FeatureNotSupportedException

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

InvalidOperationException

Windows: Thrown when the callback custom URL scheme is not registered in the AppxManifest.xml file.

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

Applies to

Share via