Skip to content

Commit

Permalink
docs: Updated xml docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
HavenDV committed Jan 24, 2024
1 parent 02a1bb2 commit 04da159
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
26 changes: 14 additions & 12 deletions src/libs/Maui.Biometric/Abstractions/AuthenticationRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,29 +30,31 @@ public class AuthenticationRequest(
public string FallbackTitle { get; set; } = string.Empty;

/// <summary>
/// Shown when a recoverable error has been encountered during authentication.
/// The help strings are provided to give the user guidance for what went wrong.
/// If a string is null or empty, the string provided by Android is shown.
///
/// Supported Platforms: Android
/// Shown when a recoverable error has been encountered during authentication. <br/>
/// The help strings are provided to give the user guidance for what went wrong. <br/>
/// If a string is null or empty, the string provided by Android is shown. <br/>
/// <br/>
/// Supported Platforms: Android <br/>
/// </summary>
public AuthenticationHelpTexts HelpTexts { get; } = new();

/// <summary>
/// If set only allows certain authenticators to be used during authentication.
/// If set only allows certain authenticators to be used during authentication. <br/>
/// Can be set to <see cref="AuthenticationStrength.Strong"/> to use only fingerprint,
/// if the face unlocking is configured to be <see cref="AuthenticationStrength.Weak"/>,
/// but this really depends on the phone manufacturers.
/// </summary>
public AuthenticationStrength Strength { get; set; } = AuthenticationStrength.Weak;

/// <summary>
/// Sets a hint to the system for whether to require user confirmation after authentication.
/// For example, implicit modalities like face and iris are passive, meaning they don't require an explicit user action to complete authentication.
/// If set to true, these modalities should require the user to take some action (e.g. press a button) before AuthenticateAsync() returns.
///
/// Supported Platforms: Android
/// Default: true
/// Sets a hint to the system for whether to require user confirmation after authentication. <br/>
/// For example, implicit modalities like face and iris are passive,
/// meaning they don't require an explicit user action to complete authentication. <br/>
/// If set to true, these modalities should require the user
/// to take some action (e.g. press a button) before AuthenticateAsync() returns. <br/>
/// <br/>
/// Supported Platforms: Android <br/>
/// Default: true <br/>
/// </summary>
public bool ConfirmationRequired { get; set; } = true;
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Maui.Biometric.Abstractions;

/// <summary>
/// Enumeration that optionally filters out authenticator methods to use.
/// Enumeration that optionally filters out authenticator methods to use. <br/>
/// You can filter by strong or weak authentication methods or can allow alternative methods by using Any.
/// </summary>
public enum AuthenticationStrength
Expand Down

0 comments on commit 04da159

Please sign in to comment.