feat: added a way to confirm if a platform is supported by the plugin (…

…#9)

Plugin.Maui.Biometric/Plugin.Maui.Biometric/AuthenticationRequest.cs

@@ -5,7 +5,7 @@ public class AuthenticationRequest
     public bool AllowPasswordAuth { get; set; }
     public string Title { get; set; }
     public string Subtitle { get; set; }
-    public string NegativeText { get; set; } 
-    public string Description { get; set; } 
+    public string NegativeText { get; set; }
+    public string Description { get; set; }
     public AuthenticatorStrength AuthStrength { get; set; }
 }

Plugin.Maui.Biometric/Plugin.Maui.Biometric/AuthenticationResponse.cs

@@ -5,4 +5,4 @@ public class AuthenticationResponse
     public BiometricResponseStatus Status { get; set; }
     public AuthenticationType AuthenticationType { get; set; }
     public string ErrorMsg { get; set; }
-}
+}

Plugin.Maui.Biometric/Plugin.Maui.Biometric/AuthenticatorStrength.cs

@@ -5,6 +5,7 @@ public enum AuthenticatorStrength
 {
     //Authentication using a Class 3 biometric, as defined on the Android compatibility definition page.
     Strong,
+
     //Authentication using a Class 2 biometric, as defined on the Android compatibility definition page.
     Weak
 }

Plugin.Maui.Biometric/Plugin.Maui.Biometric/BiometricAuthenticationService.cs

@@ -1,6 +1,6 @@
 namespace Plugin.Maui.Biometric;
 
-public class BiometricAuthenticationService
+public static class BiometricAuthenticationService
 {
     private static readonly Lazy<IBiometric> defaultImpl =
         new(() => new BiometricService(), LazyThreadSafetyMode.PublicationOnly);

Plugin.Maui.Biometric/Plugin.Maui.Biometric/BiometricHwStatus.cs

@@ -6,11 +6,11 @@
 /// </summary>
 public enum BiometricHwStatus
 {
-	NoHardware,
-	Unavailable,
-	Unsupported,
-	NotEnrolled,
-	LockedOut,
+    NoHardware,
+    Unavailable,
+    Unsupported,
+    NotEnrolled,
+    LockedOut,
     Success,
     Failure
 }

Plugin.Maui.Biometric/Plugin.Maui.Biometric/BiometricResponseStatus.cs

@@ -2,6 +2,6 @@
 
 public enum BiometricResponseStatus
 {
-	Failure,
-	Success
+    Failure,
+    Success
 }

Plugin.Maui.Biometric/Plugin.Maui.Biometric/BiometricService.cs

@@ -1,10 +1,14 @@
-namespace Plugin.Maui.Biometric;
+namespace Plugin.Maui.Biometric;
 
 internal partial class BiometricService : IBiometric
 {
+    public bool IsPlatformSupported { get; } = GetIsPlatformSupported();
+
     public partial Task<BiometricHwStatus> GetAuthenticationStatusAsync(AuthenticatorStrength authStrength = AuthenticatorStrength.Strong);
 
     public partial Task<AuthenticationResponse> AuthenticateAsync(AuthenticationRequest request, CancellationToken token);
 
     public partial Task<List<BiometricType>> GetEnrolledBiometricTypesAsync();
+
+    private static partial bool GetIsPlatformSupported();
 }

Plugin.Maui.Biometric/Plugin.Maui.Biometric/BiometricService.net.cs

@@ -1,4 +1,4 @@
-namespace Plugin.Maui.Biometric;
+namespace Plugin.Maui.Biometric;
 #if NET && !ANDROID && !IOS
 internal partial class BiometricService : IBiometric
 {
@@ -16,5 +16,7 @@ public partial Task<List<BiometricType>> GetEnrolledBiometricTypesAsync()
     {
         throw new NotImplementedException();
     }
+
+    private static partial bool GetIsPlatformSupported() => false;
 }
 #endif

Plugin.Maui.Biometric/Plugin.Maui.Biometric/BiometricType.cs

@@ -1,8 +1,8 @@
 namespace Plugin.Maui.Biometric;
+
 public enum BiometricType
 {
     None,
     Fingerprint,
     Face
-}
-
+}

Plugin.Maui.Biometric/Plugin.Maui.Biometric/IBiometric.cs

@@ -1,8 +1,12 @@
-namespace Plugin.Maui.Biometric;
+namespace Plugin.Maui.Biometric;
 
 public interface IBiometric
 {
     Task<BiometricHwStatus> GetAuthenticationStatusAsync(AuthenticatorStrength authStrength = AuthenticatorStrength.Strong);
+
     Task<AuthenticationResponse> AuthenticateAsync(AuthenticationRequest request, CancellationToken token);
+
     Task<List<BiometricType>> GetEnrolledBiometricTypesAsync();
+
+    bool IsPlatformSupported { get; }
 }

Plugin.Maui.Biometric/Plugin.Maui.Biometric/Platforms/Android/AuthCallback.cs

@@ -23,7 +23,7 @@ public override void OnAuthenticationSucceeded(BiometricPrompt.AuthenticationRes
             ErrorMsg = string.Empty
         });
     }
-    
+
     public override void OnAuthenticationError(int errorCode, ICharSequence errString)
     {
         base.OnAuthenticationError(errorCode, errString);

Plugin.Maui.Biometric/Plugin.Maui.Biometric/Platforms/Android/BiometricService.android.cs

@@ -125,4 +125,6 @@ public partial Task<List<BiometricType>> GetEnrolledBiometricTypesAsync()
         }
         return Task.FromResult(availableOptions);
     }
+
+    private static partial bool GetIsPlatformSupported() => true;
 }

Plugin.Maui.Biometric/Plugin.Maui.Biometric/Platforms/iOS/BiometricService.ios.cs

@@ -64,4 +64,6 @@ public partial Task<List<BiometricType>> GetEnrolledBiometricTypesAsync()
         }
         return Task.FromResult(availableOptions);
     }
+
+    private static partial bool GetIsPlatformSupported() => true;
 }

Plugin.Maui.Biometric/Plugin.Maui.Biometric/Plugin.Maui.Biometric.csproj

@@ -9,14 +9,14 @@
 		<SkipValidateMauiImplicitPackageReferences>true</SkipValidateMauiImplicitPackageReferences>
 		<AssemblyVersion>0.0.2</AssemblyVersion>
 		<AssemblyFileVersion>0.0.2</AssemblyFileVersion>
-		<Version>0.0.2-pre</Version>
+		<Version>0.0.2</Version>
 		<NeutralLanguage>en</NeutralLanguage>
 		<!--Version of C# to use -->
 		<PackageId>Plugin.Maui.Biometric</PackageId>
 		<LangVersion>latest</LangVersion>
 		<Authors>FreakyAli</Authors>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
-		<Description>A Biometric plugin for .NET MAUI</Description>
+		<Description>A Biometric plug-in for .NET MAUI</Description>
 		<PackageIcon>auth_icon.jpg</PackageIcon>
 		<RepositoryUrl>https://github.com/FreakyAli/Plugin.Maui.Biometric</RepositoryUrl>
 		<PackageProjectUrl>https://github.com/FreakyAli/Plugin.Maui.Biometric</PackageProjectUrl>
@@ -40,13 +40,13 @@
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 	</PropertyGroup>
 	<PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Release|net8.0-ios|AnyCPU'">
-	  <CreatePackage>false</CreatePackage>
+		<CreatePackage>false</CreatePackage>
 	</PropertyGroup>
 	<ItemGroup>
 		<None Remove="Platforms\Android\" />
 		<None Remove="Platforms\iOS\" />
 		<None Include="auth_icon.jpg" Pack="true" Visible="false" PackagePath="" />
-	    <None Include="Readme.md" Pack="true" Visible="false" PackagePath="" />
+		<None Include="Readme.md" Pack="true" Visible="false" PackagePath="" />
 	</ItemGroup>
 	<ItemGroup>
 		<Folder Include="Platforms\Android\" />

Plugin.Maui.Biometric/Samples/App.xaml

@@ -1,8 +1,9 @@
-<?xml version = "1.0" encoding = "UTF-8" ?>
-<Application xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
-             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
-             xmlns:local="clr-namespace:Samples"
-             x:Class="Samples.App">
+<?xml version="1.0" encoding="UTF-8" ?>
+<Application
+    x:Class="Samples.App"
+    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
+    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
+    xmlns:local="clr-namespace:Samples">
     <Application.Resources>
         <ResourceDictionary>
             <ResourceDictionary.MergedDictionaries>
@@ -11,5 +12,4 @@
             </ResourceDictionary.MergedDictionaries>
         </ResourceDictionary>
     </Application.Resources>
-</Application>
-
+</Application>

Plugin.Maui.Biometric/Samples/App.xaml.cs

@@ -2,11 +2,10 @@
 
 public partial class App : Application
 {
-	public App()
-	{
-		InitializeComponent();
-
-		MainPage = new AppShell();
-	}
-}
+    public App()
+    {
+        InitializeComponent();
 
+        MainPage = new AppShell();
+    }
+}

Plugin.Maui.Biometric/Samples/AppShell.xaml

@@ -4,13 +4,11 @@
     xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
     xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
     xmlns:local="clr-namespace:Samples"
-    Shell.FlyoutBehavior="Disabled"
-    Title="Samples">
+    Title="Samples"
+    Shell.FlyoutBehavior="Disabled">
 
     <ShellContent
         Title="Home"
         ContentTemplate="{DataTemplate local:MainPage}"
         Route="MainPage" />
-
-</Shell>
-
+</Shell>

Plugin.Maui.Biometric/Samples/AppShell.xaml.cs

@@ -2,9 +2,8 @@
 
 public partial class AppShell : Shell
 {
-	public AppShell()
-	{
-		InitializeComponent();
-	}
-}
-
+    public AppShell()
+    {
+        InitializeComponent();
+    }
+}

Plugin.Maui.Biometric/Samples/MainPage.xaml

@@ -1,37 +1,34 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
-             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
-             x:Class="Samples.MainPage">
+<ContentPage
+    x:Class="Samples.MainPage"
+    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
+    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml">
 
     <ScrollView>
-        <VerticalStackLayout
-            Padding="30,0"
-            Spacing="25">
+        <VerticalStackLayout Padding="30,0" Spacing="25">
             <Image
-                Source="dotnet_bot.png"
-                HeightRequest="185"
                 Aspect="AspectFit"
-                SemanticProperties.Description="dot net bot in a race car number eight" />
+                HeightRequest="185"
+                SemanticProperties.Description="dot net bot in a race car number eight"
+                Source="dotnet_bot.png" />
 
             <Label
-                Text="Hello, World!"
+                SemanticProperties.HeadingLevel="Level1"
                 Style="{StaticResource Headline}"
-                SemanticProperties.HeadingLevel="Level1" />
+                Text="Hello, World!" />
 
             <Label
-                Text="Welcome to &#10;.NET Multi-platform App UI"
-                Style="{StaticResource SubHeadline}"
+                SemanticProperties.Description="Welcome to dot net Multi platform App U I"
                 SemanticProperties.HeadingLevel="Level2"
-                SemanticProperties.Description="Welcome to dot net Multi platform App U I" />
+                Style="{StaticResource SubHeadline}"
+                Text="Welcome to &#10;.NET Multi-platform App UI" />
 
             <Button
                 x:Name="CounterBtn"
-                Text="Click me" 
-                SemanticProperties.Hint="Counts the number of times you click"
                 Clicked="OnCounterClicked"
-                HorizontalOptions="Fill" />
+                HorizontalOptions="Fill"
+                SemanticProperties.Hint="Counts the number of times you click"
+                Text="Click me" />
         </VerticalStackLayout>
     </ScrollView>
-
-</ContentPage>
-
+</ContentPage>

Plugin.Maui.Biometric/Samples/MainPage.xaml.cs

@@ -25,13 +25,13 @@ private async void OnCounterClicked(object sender, EventArgs e)
             {
                 Title = "A good title",
                 Subtitle = "An equally good subtitle",
-                NegativeText= "Cancel",
+                NegativeText = "Cancel",
                 Description = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua",
                 AllowPasswordAuth = false,
             };
             // biometric authentication
             var data = await biometric.AuthenticateAsync(req,
-                CancellationToken.None); // You can also pass a valid token and use it to cancel this tsak 
+                CancellationToken.None); // You can also pass a valid token and use it to cancel this tsak
 
             Console.Write(data);
         }

Plugin.Maui.Biometric/Samples/MauiProgram.cs

@@ -1,23 +1,21 @@
-using Microsoft.Extensions.DependencyInjection;
-using Plugin.Maui.Biometric;
-
-namespace Samples;
-
-public static class MauiProgram
-{
-	public static MauiApp CreateMauiApp()
-	{
-		var builder = MauiApp.CreateBuilder();
-		builder
-			.UseMauiApp<App>()
-			.ConfigureFonts(fonts =>
-			{
-				fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
-				fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
-			});
-
-		builder.Services.AddSingleton<IBiometric>(BiometricAuthenticationService.Default);
-		return builder.Build();
-	}
-}
-
+using Plugin.Maui.Biometric;
+
+namespace Samples;
+
+public static class MauiProgram
+{
+    public static MauiApp CreateMauiApp()
+    {
+        var builder = MauiApp.CreateBuilder();
+        builder
+            .UseMauiApp<App>()
+            .ConfigureFonts(fonts =>
+            {
+                fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
+                fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
+            });
+
+        builder.Services.AddSingleton<IBiometric>(BiometricAuthenticationService.Default);
+        return builder.Build();
+    }
+}

Plugin.Maui.Biometric/Samples/Platforms/Android/MainActivity.cs

@@ -7,5 +7,4 @@ namespace Samples;
 [Activity(Theme = "@style/Maui.SplashTheme", MainLauncher = true, ConfigurationChanges = ConfigChanges.ScreenSize | ConfigChanges.Orientation | ConfigChanges.UiMode | ConfigChanges.ScreenLayout | ConfigChanges.SmallestScreenSize | ConfigChanges.Density)]
 public class MainActivity : MauiAppCompatActivity
 {
-}
-
+}