Lokale Benachrichtigungen

Einleitung

Nylo Website bietet ein lokales Benachrichtigungssystem über die Klasse LocalNotification. Dies ermöglicht es Ihnen, sofortige oder geplante Benachrichtigungen mit reichhaltigen Inhalten auf iOS und Android zu senden.

Lokale Benachrichtigungen werden im Web nicht unterstützt. Der Versuch, sie im Web zu verwenden, löst eine NotificationException aus.

Grundlegende Verwendung

Senden Sie eine Benachrichtigung mit dem Builder-Pattern oder der statischen Methode:

import 'package:nylo_framework/nylo_framework.dart';

// Builder pattern
await LocalNotification(title: "Hello", body: "World").send();

// Using the helper function
await localNotification("Hello", "World").send();

// Using the static method
await LocalNotification.sendNotification(
  title: "Hello",
  body: "World",
);

Geplante Benachrichtigungen

Planen Sie eine Benachrichtigung zur Zustellung zu einem bestimmten Zeitpunkt:

// Schedule for tomorrow
final tomorrow = DateTime.now().add(Duration(days: 1));

await LocalNotification(
  title: "Reminder",
  body: "Don't forget your appointment!",
).send(at: tomorrow);

// Using the static method
await LocalNotification.sendNotification(
  title: "Reminder",
  body: "Don't forget your appointment!",
  at: tomorrow,
);

Builder-Pattern

Die Klasse LocalNotification bietet eine fluent Builder-API. Alle verkettbaren Methoden geben die LocalNotification-Instanz zurück:

await LocalNotification(title: "New Photo", body: "Check this out!")
    .addPayload("photo_id:123")
    .addId(42)
    .addSubtitle("From your friend")
    .addBadgeNumber(3)
    .addSound("custom_sound.wav")
    .send();

Verkettbare Methoden

send()

Future<void> send({
  DateTime? at,
  AndroidScheduleMode? androidScheduleMode,
})

Wenn at angegeben wird, wird die Benachrichtigung für diesen Zeitpunkt geplant. Andernfalls wird sie sofort angezeigt.

Plattformkonfiguration

In v7 werden plattformspezifische Optionen über AndroidNotificationConfig- und IOSNotificationConfig-Objekte konfiguriert.

Android-Konfiguration

Übergeben Sie eine AndroidNotificationConfig an setAndroidConfig():

await LocalNotification(
  title: "Android Notification",
  body: "With custom configuration",
)
.setAndroidConfig(AndroidNotificationConfig(
  channelId: "custom_channel",
  channelName: "Custom Channel",
  channelDescription: "Notifications from custom channel",
  importance: Importance.max,
  priority: Priority.high,
  enableVibration: true,
  vibrationPattern: [0, 1000, 500, 1000],
  enableLights: true,
  ledColor: Color(0xFF00FF00),
))
.send();

AndroidNotificationConfig-Eigenschaften

iOS-Konfiguration

Übergeben Sie eine IOSNotificationConfig an setIOSConfig():

await LocalNotification(
  title: "iOS Notification",
  body: "With custom configuration",
)
.setIOSConfig(IOSNotificationConfig(
  presentAlert: true,
  presentBanner: true,
  presentSound: true,
  threadIdentifier: "thread_1",
  interruptionLevel: InterruptionLevel.active,
))
.addBadgeNumber(1)
.addSound("custom_sound.wav")
.send();

IOSNotificationConfig-Eigenschaften

Anhänge (nur iOS)

Fügen Sie Bild-, Audio- oder Videoanhänge zu iOS-Benachrichtigungen hinzu. Anhänge werden von einer URL heruntergeladen:

await LocalNotification(
  title: "New Photo",
  body: "Check out this image!",
)
.addAttachment(
  "https://example.com/image.jpg",
  "photo.jpg",
  showThumbnail: true,
)
.send();

Benachrichtigungen verwalten

Eine bestimmte Benachrichtigung abbrechen

await LocalNotification.cancelNotification(42);

// With a tag (Android)
await LocalNotification.cancelNotification(42, tag: "my_tag");

Alle Benachrichtigungen abbrechen

await LocalNotification.cancelAllNotifications();

Badge-Zähler zurücksetzen

await LocalNotification.clearBadgeCount();

Berechtigungen

Fordern Sie Benachrichtigungsberechtigungen vom Benutzer an:

// Request with defaults
await LocalNotification.requestPermissions();

// Request with specific options
await LocalNotification.requestPermissions(
  alert: true,
  badge: true,
  sound: true,
  provisional: false,
  critical: false,
  vibrate: true,
  enableLights: true,
  channelId: 'default_notification_channel_id',
  channelName: 'Default Notification Channel',
);

Berechtigungen werden beim ersten Senden einer Benachrichtigung automatisch über NyScheduler.taskOnce angefordert.

Plattform-Setup

iOS-Setup

Fügen Sie zu Ihrer Info.plist hinzu:

<key>UIBackgroundModes</key>
<array>
    <string>remote-notification</string>
</array>

Android-Setup

Fügen Sie zu Ihrer AndroidManifest.xml hinzu:

<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.USE_FULL_SCREEN_INTENT" />

API-Referenz

Statische Methoden

Instanzmethoden (verkettbar)