Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

Commit

Permalink
Update WebAuthenticator.xml to document exception types (#2129)
Browse files Browse the repository at this point in the history
AuthenticateAsync throws a TaskCanceledException if the user aborts the process. This should be included in the documentation
  • Loading branch information
peterfoot authored Feb 26, 2024
1 parent 2659649 commit c392f9a
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/en/Xamarin.Essentials/WebAuthenticator.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
<param name="callbackUrl">Expected callback url that the navigation flow will eventually redirect to.</param>
<summary>Begin an authentication flow by navigating to the specified url and waiting for a callback/redirect to the callbackUrl scheme.</summary>
<returns>Returns a result parsed out from the callback url.</returns>
<exception cref="TaskCanceledException">The user canceled the authentication flow.</exception>
<remarks></remarks>
</Docs>
</Member>
Expand Down

0 comments on commit c392f9a

Please sign in to comment.