Indiko.Blocks.Messaging.PushNotification 2.1.1

Indiko.Blocks.Messaging.PushNotification

Push notification messaging implementation for sending notifications to mobile devices (iOS, Android, Web).

Overview

This package provides push notification capabilities for mobile and web applications with support for multiple platforms.

Features

• Multi-Platform: iOS (APNs), Android (FCM), Web Push
• Batch Sending: Send to multiple devices
• Data Payloads: Custom data with notifications
• Badge/Sound: Badge counts and custom sounds
• Template Support: Message templates
• Delivery Tracking: Track notification delivery

Installation

dotnet add package Indiko.Blocks.Messaging.PushNotification

Configuration

appsettings.json

{
  "PushNotificationOptions": {
    "Enabled": true,
    "Provider": "Firebase",
    "FirebaseServerKey": "your-firebase-server-key",
    "FirebaseProjectId": "your-project-id",
    "ApnsCertificatePath": "path/to/apns-cert.p12",
    "ApnsCertificatePassword": "cert-password",
    "ApnsUseSandbox": false
  }
}

Quick Start

Send to Single Device

public class NotificationService
{
    private readonly IPushNotificationSender _notificationSender;

    public async Task SendWelcomeNotificationAsync(string deviceToken)
    {
        var notification = new PushNotificationMessage
        {
            DeviceTokens = new[] { deviceToken },
            Title = "Welcome!",
            Body = "Thanks for installing our app.",
            Data = new Dictionary<string, string>
            {
                { "type", "welcome" },
                { "screen", "home" }
            }
        };

        var result = await _notificationSender.SendAsync(notification);
        
        if (!result.Success)
        {
            _logger.LogError($"Failed to send notification: {result.ErrorMessage}");
        }
    }
}

Send to Multiple Devices

public async Task NotifyAllUsersAsync(string title, string message)
{
    var deviceTokens = await _userRepository.GetAllDeviceTokensAsync();
    
    var notification = new PushNotificationMessage
    {
        DeviceTokens = deviceTokens.ToArray(),
        Title = title,
        Body = message,
        Data = new Dictionary<string, string>
        {
            { "broadcast", "true" },
            { "timestamp", DateTime.UtcNow.ToString() }
        }
    };

    await _notificationSender.SendAsync(notification);
}

iOS-Specific Features

var notification = new PushNotificationMessage
{
    DeviceTokens = new[] { iosDeviceToken },
    Title = "New Message",
    Body = "You have a new message from John",
    Badge = 5,  // Badge count
    Sound = "notification.wav",  // Custom sound
    Data = new Dictionary<string, string>
    {
        { "messageId", "12345" },
        { "senderId", "user-789" }
    }
};

Android-Specific Features

var notification = new PushNotificationMessage
{
    DeviceTokens = new[] { androidDeviceToken },
    Title = "Order Update",
    Body = "Your order has been shipped!",
    Data = new Dictionary<string, string>
    {
        { "orderId", order.Id.ToString() },
        { "trackingNumber", order.TrackingNumber },
        { "priority", "high" },
        { "clickAction", "ORDER_DETAILS" }
    }
};

Platform Setup

Firebase Cloud Messaging (FCM)

1. Create Firebase project
2. Get Server Key from Firebase Console
3. Configure in appsettings.json

Apple Push Notification Service (APNs)

1. Create APNs certificate in Apple Developer Portal
2. Export as .p12 file
3. Configure certificate path and password

Web Push

1. Generate VAPID keys
2. Configure public/private keys
3. Add service worker to web app

Best Practices

1. Token Management: Keep device tokens updated
2. Error Handling: Handle invalid/expired tokens
3. Delivery Reports: Track delivery status
4. Rate Limiting: Respect platform limits
5. Batching: Batch notifications for efficiency
6. Testing: Test on real devices
7. User Preferences: Respect notification preferences

Target Framework

• .NET 10

Dependencies

• Indiko.Blocks.Messaging.Abstractions
• Platform-specific SDKs (Firebase, APNs)

Related Packages

• Indiko.Blocks.Messaging.AzureNotificationHub
• Indiko.Blocks.Messaging.Abstractions