Shiny Notifications

Setup

Register the notification services in your MauiProgram.cs:

using Shiny;

// Without a delegate (fire-and-forget notifications)
services.AddNotifications();

// With a delegate to handle notification taps
services.AddNotifications<MyNotificationDelegate>();

On iOS, you can optionally pass an IosConfiguration to control authorization and presentation options:

#if IOS || MACCATALYST
services.AddNotifications<MyNotificationDelegate>(new IosConfiguration(
    UNAuthorizationOptions: UNAuthorizationOptions.Alert | UNAuthorizationOptions.Badge | UNAuthorizationOptions.Sound,
    PresentationOptions: UNNotificationPresentationOptions.Banner | UNNotificationPresentationOptions.Badge | UNNotificationPresentationOptions.Sound
));
#endif

Code Generation Instructions

When generating code that uses Shiny Notifications, follow these conventions:

1. Always request access before sending notifications:

   var access = await notificationManager.RequestAccess();
   if (access != AccessState.Available)
   {
       // Handle denied permission
       return;
   }
   

2. Use AccessRequestFlags when the notification uses triggers:

   • AccessRequestFlags.TimeSensitivity for scheduled or repeating notifications.
   • AccessRequestFlags.LocationAware for geofence-triggered notifications.
   • Or use the RequestRequiredAccess extension method that infers flags from the notification object.

3. A Notification must have a Message set -- validation will throw otherwise.

4. Only one trigger type per notification -- you cannot mix ScheduleDate, RepeatInterval, and Geofence on the same notification.

5. Implement INotificationDelegate for handling user taps:

   public class MyNotificationDelegate : INotificationDelegate
   {
       public async Task OnEntry(NotificationResponse response)
       {
           // response.Notification -- the original notification
           // response.ActionIdentifier -- which action button was pressed
           // response.Text -- text reply if action was TextReply type
       }
   }
   

6. Create channels before sending notifications that reference them:

   notificationManager.AddChannel(new Channel
   {
       Identifier = "alerts",
       Importance = ChannelImportance.High,
       Sound = ChannelSound.High
   });
   

7. Use the convenience Send extension for simple notifications:

   await notificationManager.Send("Title", "Message body");
   

8. For platform-specific properties, use the native subclasses:

   • Android: AndroidNotification and AndroidChannel
   • iOS: AppleNotification and AppleChannel

9. Always inject INotificationManager via constructor injection -- never create instances directly.

10. Use CancelScope wisely when cancelling:

    • CancelScope.DisplayedOnly -- clears only shown notifications.
    • CancelScope.Pending -- clears only scheduled/triggered notifications.
    • CancelScope.All -- clears everything (default).

Namespace Ambiguities

• Notification: Both Shiny.Notifications and Shiny.Push define a Notification type. If both packages are referenced in the same project, do NOT add both namespaces as global usings. Use Shiny.Notifications.Notification FQN or a file-level using Shiny.Notifications; directive to disambiguate.

Best Practices

• Always check the AccessState result before attempting to send notifications.
• Use channels to group notifications by category (e.g., "alerts", "reminders", "messages").
• The default channel (Channel.Default) always exists with Identifier = "Notifications" and ChannelImportance.Low.
• Do not remove the default channel -- the library will throw an InvalidOperationException.
• Set BadgeCount only on immediate notifications (not triggered ones) -- validation will fail otherwise.
• Use IntervalTrigger with either Interval (raw TimeSpan) or TimeOfDay (daily/weekly recurring), never both.
• For geofence notifications, ensure Center and Radius are both set on GeofenceTrigger.
• On Android, create a drawable resource named notification for the default small icon, or set SmallIconResourceName on AndroidNotification.
• Prefer the RequestRequiredAccess extension method to automatically determine needed permission flags from a Notification object.
• Use Payload dictionary on Notification to pass custom data that you can read back in your INotificationDelegate.OnEntry.

Reference Files

• API Reference