Merge android-notification-channel-groups into develop

.editorconfig

@@ -175,4 +175,4 @@ dotnet_diagnostic.IDE0051.severity = warning
 dotnet_diagnostic.CS1591.severity = none
 
 # CA1416: Validate platform compatibility
-dotnet_diagnostic.CA1416.severity = info
+dotnet_diagnostic.CA1416.severity = suggestion

.github/PULL_REQUEST_TEMPLATE.md

@@ -3,7 +3,7 @@
 
 #### Issues
 <!-- Add affected issue(s) here. -->
-*
+* 
 
 #### Checklist
 <!-- Read the following checklist and tick items off when complete. Use an `X` inside the brackets to mark as done. -->

Plugin.FirebasePushNotifications/Constants.cs

@@ -8,8 +8,6 @@ internal static partial class Constants
         internal const string NotificationDataKey = "data";
         internal const string PriorityKey = "priority";
 
-        internal const string SuppressedString = "{suppressed}";
-
         internal static class Preferences
         {
             private const string KeyPrefix = "Plugin.FirebasePushNotifications";

Plugin.FirebasePushNotifications/CrossFirebasePushNotification.cs

@@ -47,6 +47,7 @@ private static IFirebasePushNotification CreateFirebasePushNotification()
             var preferences = IPlatformApplication.Current.Services.GetService<IFirebasePushNotificationPreferences>();
 
 #if ANDROID
+            var notificationChannels = IPlatformApplication.Current.Services.GetService<INotificationChannels>();
             var notificationBuilder = IPlatformApplication.Current.Services.GetService<INotificationBuilder>();
 #endif
 
@@ -58,6 +59,7 @@ private static IFirebasePushNotification CreateFirebasePushNotification()
                 preferences
 #if ANDROID
                 ,
+                notificationChannels,
                 notificationBuilder
 #endif
                 );

Plugin.FirebasePushNotifications/Extensions/DictionaryExtensions.cs

@@ -68,17 +68,18 @@ public static bool TryGetBool(this IDictionary<string, object> items, string key
                 value = boolValue;
                 return true;
             }
-            else if (items.TryGetString(key, out var stringValue))
+
+            if (items.TryGetString(key, out var stringValue))
             {
-                if (stringValue.Equals("true", StringComparison.InvariantCultureIgnoreCase) ||
-                    stringValue.Equals("1", StringComparison.InvariantCultureIgnoreCase))
+                if (stringValue.Equals("1", StringComparison.InvariantCultureIgnoreCase) ||
+                    stringValue.Equals("true", StringComparison.InvariantCultureIgnoreCase))
                 {
                     value = true;
                     return true;
                 }
-                else if (
-                    stringValue.Equals("false", StringComparison.InvariantCultureIgnoreCase) ||
-                    stringValue.Equals("0", StringComparison.InvariantCultureIgnoreCase))
+
+                if (stringValue.Equals("0", StringComparison.InvariantCultureIgnoreCase) ||
+                    stringValue.Equals("false", StringComparison.InvariantCultureIgnoreCase))
                 {
                     value = false;
                     return true;

Plugin.FirebasePushNotifications/Extensions/MauiAppBuilderExtensions.cs

@@ -3,7 +3,6 @@
 #if ANDROID || IOS
 using Plugin.FirebasePushNotifications.Platforms;
 using Plugin.FirebasePushNotifications.Platforms.Channels;
-using Plugin.FirebasePushNotifications.Model.Queues;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 #endif
 
@@ -101,8 +100,8 @@ public static MauiAppBuilder UseFirebasePushNotifications(this MauiAppBuilder bu
 
             // Service registrations
 #if ANDROID || IOS
-            builder.Services.AddSingleton(c => IFirebasePushNotification.Current);
-            builder.Services.AddSingleton(c => INotificationPermissions.Current);
+            builder.Services.AddSingleton(_ => IFirebasePushNotification.Current);
+            builder.Services.AddSingleton(_ => INotificationPermissions.Current);
             builder.Services.TryAddSingleton<IFirebasePushNotificationPreferences, FirebasePushNotificationPreferences>();
             builder.Services.TryAddSingleton<IPreferences>(_ => Preferences.Default);
             builder.Services.AddSingleton(defaultOptions);

Plugin.FirebasePushNotifications/FirebasePushNotificationOptions.cs

@@ -5,7 +5,11 @@ namespace Plugin.FirebasePushNotifications
 {
     public class FirebasePushNotificationOptions
     {
-        public virtual bool AutoInitEnabled { get; set; }
+        /// <summary>
+        /// Indicates if the underlying Firebase library should be initialized automatically.
+        /// Default: <c>true</c>
+        /// </summary>
+        public virtual bool AutoInitEnabled { get; set; } = true;
 
         /// <summary>
         /// The factory used to create new queues to intercept push notification events.
@@ -21,9 +25,15 @@ public class FirebasePushNotificationOptions
         public virtual IQueueFactory QueueFactory { get; set; }
 
 #if ANDROID
-        public virtual FirebasePushNotificationAndroidOptions Android { get; set; } = new FirebasePushNotificationAndroidOptions();
+        /// <summary>
+        /// Android-specific options.
+        /// </summary>
+        public virtual FirebasePushNotificationAndroidOptions Android { get; } = new FirebasePushNotificationAndroidOptions();
 #elif IOS
-        public virtual FirebasePushNotificationiOSOptions iOS { get; set; } = new FirebasePushNotificationiOSOptions();
+        /// <summary>
+        /// iOS-specific options.
+        /// </summary>
+        public virtual FirebasePushNotificationiOSOptions iOS { get; } = new FirebasePushNotificationiOSOptions();
 #endif
 
         public override string ToString()

Plugin.FirebasePushNotifications/INotificationChannels.cs

@@ -1,18 +1,13 @@
-namespace Plugin.FirebasePushNotifications
-{
-    /// <summary>
-    /// Cross-platform interface to handle notification channels.
-    /// </summary>
-    /// <remarks>
-    /// The concept of notification channels does only exist on Android.
-    /// This cross-platform interfaces allows to update all existing
-    /// notification channels from platform-independent code.
-    /// </remarks>
-    public partial interface INotificationChannels
-    {
-        /// <summary>
-        /// Updates all existing notification channels.
-        /// </summary>
-        void UpdateChannels();
-    }
-}
+namespace Plugin.FirebasePushNotifications
+{
+    /// <summary>
+    /// Cross-platform interface to handle notification channels.
+    /// </summary>
+    /// <remarks>
+    /// The concept of notification channels exists on Android only.
+    /// This interface is mainly used to simplify dependency injection.
+    /// </remarks>
+    public partial interface INotificationChannels
+    {
+    }
+}

Plugin.FirebasePushNotifications/Internals/TokenFormatter.cs

@@ -14,15 +14,15 @@ internal static string AnonymizeToken(string token)
                 var substringLength = Math.Min(10, token.Length / 10);
                 if (substringLength < 5)
                 {
-                    return Constants.SuppressedString;
+                    return "...";
                 }
 
-                return $"{Constants.SuppressedString}...{token[^substringLength..]}";
+                return $"{token[..substringLength]}...{token[^substringLength..]}".Trim(new[] { '\n', '\r', ' ' });
             }
-            catch
+            catch (Exception ex)
             {
-                return Constants.SuppressedString;
+                return ex.Message;
             }
         }
     }
-}
+}

Plugin.FirebasePushNotifications/Platforms/Android/Channels/INotificationChannels.cs

@@ -1,4 +1,6 @@
-using Plugin.FirebasePushNotifications.Platforms.Channels;
+using System.Diagnostics.CodeAnalysis;
+using Android.App;
+using Plugin.FirebasePushNotifications.Platforms.Channels;
 
 namespace Plugin.FirebasePushNotifications
 {
@@ -7,32 +9,100 @@ namespace Plugin.FirebasePushNotifications
     /// </summary>
     public partial interface INotificationChannels
     {
+        /// <summary>
+        /// Gets the singleton instance of <see cref="INotificationChannels"/>.
+        /// </summary>
+        public static INotificationChannels Current { get; set; } = NotificationChannels.Current;
+
         /// <summary>
         /// Gets the list of configured notification channels.
         /// </summary>
-        IEnumerable<NotificationChannelRequest> Channels { get; }
+        NotificationChannels.NotificationChannelsDelegate Channels { get; }
+
+        /// <summary>
+        /// Gets the list of configured notification channel groups.
+        /// </summary>
+        IEnumerable<NotificationChannelGroup> ChannelGroups { get; }
+
+        /// <summary>
+        /// Sets notification channel groups from given <paramref name="notificationChannelGroupRequests"/>.
+        /// </summary>
+        /// <remarks>
+        /// If the <paramref name="notificationChannelGroupRequests"/> already exist, they're updated.
+        /// </remarks>
+        /// <param name="notificationChannelGroupRequests">The notification channel group requests.</param>
+        void SetNotificationChannelGroups(NotificationChannelGroupRequest[] notificationChannelGroupRequests);
+
+        /// <summary>
+        /// Creates notification channel groups.
+        /// </summary>
+        /// <remarks>
+        /// Important: Create notification channel groups before you create notification channels!
+        /// </remarks>
+        /// <param name="notificationChannelGroupRequests">The notification channel group requests.</param>
+        void CreateNotificationChannelGroups(NotificationChannelGroupRequest[] notificationChannelGroupRequests);
+
+        /// <summary>
+        /// Deletes the notification channel group with <paramref name="groupId"/>.
+        /// </summary>
+        /// <param name="groupId">The identifier of the notification channel group.</param>
+        void DeleteNotificationChannelGroup(string groupId);
 
         /// <summary>
-        /// Create Android notification channels from given <paramref name="notificationChannelRequests"/>.
+        /// Deletes the notification channel groups with <paramref name="groupIds"/>.
         /// </summary>
+        /// <param name="groupIds">The identifiers of the notification channel group.</param>
+        void DeleteNotificationChannelGroups(string[] groupIds);
+
+        /// <summary>
+        /// Deletes all notification channel groups which are configured in <see cref="Channels"/>.
+        /// </summary>
+        void DeleteAllNotificationChannelGroups();
+
+        /// <summary>
+        /// Sets notification channels from given <paramref name="notificationChannelRequests"/>.
+        /// </summary>
+        /// <remarks>
+        /// If the <paramref name="notificationChannelRequests"/> already exist, they're updated.
+        /// </remarks>
         /// <param name="notificationChannelRequests">The notification channel requests.</param>
-        void CreateChannels(NotificationChannelRequest[] notificationChannelRequests);
+        void SetNotificationChannels(NotificationChannelRequest[] notificationChannelRequests);
 
         /// <summary>
-        /// Update Android notification channels from given <paramref name="notificationChannelRequests"/>.
+        /// Creates notification channels from given <paramref name="notificationChannelRequests"/>.
         /// </summary>
+        /// <remarks>
+        /// If the <paramref name="notificationChannelRequests"/> already exist, they're updated.
+        /// </remarks>
         /// <param name="notificationChannelRequests">The notification channel requests.</param>
-        void UpdateChannels(NotificationChannelRequest[] notificationChannelRequests);
+        void CreateNotificationChannels([NotNull] NotificationChannelRequest[] notificationChannelRequests);
+
+        /// <summary>
+        /// Deletes the notification channel with the given <paramref name="notificationChannelId"/>.
+        /// </summary>
+        /// <param name="notificationChannelId">The notification channel identifier.</param>
+        void DeleteNotificationChannel(string notificationChannelId);
+
+        /// <summary>
+        /// Deletes the notification channels with the given <paramref name="notificationChannelIds"/>.
+        /// </summary>
+        /// <param name="notificationChannelIds">The notification channel identifiers.</param>
+        void DeleteNotificationChannels(string[] notificationChannelIds);
+
+        /// <summary>
+        /// Deletes all existing notification channels which are configured in <see cref="Channels"/>.
+        /// </summary>
+        void DeleteAllNotificationChannels();
 
         /// <summary>
-        /// Delete Android notification channels from given <paramref name="channelIds"/>.
+        /// Open the notification settings.
         /// </summary>
-        /// <param name="channelIds">The notification channel identifiers.</param>
-        void DeleteChannels(string[] channelIds);
+        void OpenNotificationSettings();
 
         /// <summary>
-        /// Deletes all existing notification channels.
+        /// Opens the notification channel settings for <paramref name="notificationChannelId"/>.
         /// </summary>
-        void DeleteAllChannels();
+        /// <param name="notificationChannelId">The notification channel identifier.</param>
+        void OpenNotificationChannelSettings(string notificationChannelId);
     }
 }

Plugin.FirebasePushNotifications/Platforms/Android/Channels/NotificationChannelGroupRequest.cs

@@ -0,0 +1,49 @@
+using System.Diagnostics;
+
+namespace Plugin.FirebasePushNotifications.Platforms.Channels
+{
+    /// <summary>
+    /// Notification channel group request.
+    /// </summary>
+    [DebuggerDisplay("{GroupId}")]
+    public class NotificationChannelGroupRequest
+    {
+        /// <summary>
+        /// Creates a new instance of <see cref="NotificationChannelRequest"/>.
+        /// </summary>
+        /// <param name="groupId">The group identifier.</param>
+        /// <param name="name">The group name.</param>
+        /// <param name="description">The group description (optional).</param>
+        public NotificationChannelGroupRequest(string groupId, string name, string description = null)
+        {
+            if (string.IsNullOrEmpty(groupId))
+            {
+                throw new ArgumentException("The group identifier must not be null or empty", nameof(groupId));
+            }
+
+            if (string.IsNullOrEmpty(name))
+            {
+                throw new ArgumentException("The group name must not be null or empty", nameof(name));
+            }
+
+            this.GroupId = groupId;
+            this.Name = name;
+            this.Description = description;
+        }
+
+        /// <summary>
+        /// The group identifier.
+        /// </summary>
+        public string GroupId { get; }
+
+        /// <summary>
+        /// The group name (displayed in the notification settings of the app).
+        /// </summary>
+        public string Name { get; }
+
+        /// <summary>
+        /// The group description (optional).
+        /// </summary>
+        public string Description { get; }
+    }
+}

Plugin.FirebasePushNotifications/Platforms/Android/Channels/NotificationChannelRequest.cs

@@ -42,16 +42,7 @@ public class NotificationChannelRequest
         public bool IsDefault { get; set; }
 
         /// <summary>
-        /// Determines if the current notification channel is active.
-        /// Default: <c>true</c>
-        /// </summary>
-        /// <remarks>
-        /// Inactive notification channels will be removed at app startup.
-        /// </remarks>
-        public bool IsActive { get; set; } = true;
-
-        /// <summary>
-        /// Sets or gets, what group this channel belongs to.
+        /// The group ID this channel belongs to.
         /// </summary>
         public string Group { get; set; }