Notifications locales

Introduction

Nylo Website fournit un systeme de notifications locales via la classe LocalNotification. Cela vous permet d'envoyer des notifications immediates ou planifiees avec du contenu riche sur iOS et Android.

Les notifications locales ne sont pas prises en charge sur le web. Tenter de les utiliser sur le web lancera une NotificationException.

Utilisation de base

Envoyez une notification en utilisant le patron de construction ou la methode statique :

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",
);

Notifications planifiees

Planifiez une notification pour qu'elle soit livree a un moment specifique :

// 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,
);

Patron de construction

La classe LocalNotification fournit une API de construction fluide. Toutes les methodes chainables retournent l'instance LocalNotification :

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();

Methodes chainables

send()

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

Si at est fourni, planifie la notification pour ce moment. Sinon l'affiche immediatement.

Configuration par plateforme

Les options specifiques a la plateforme sont configurees via les objets AndroidNotificationConfig et IOSNotificationConfig.

Configuration Android

Passez un AndroidNotificationConfig a 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();

Proprietes de AndroidNotificationConfig

Configuration iOS

Passez un IOSNotificationConfig a 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();

Proprietes de IOSNotificationConfig

Pieces jointes (iOS uniquement)

Ajoutez des pieces jointes image, audio ou video aux notifications iOS. Les pieces jointes sont telechargees depuis une URL :

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

Gestion des notifications

Annuler une notification specifique

await LocalNotification.cancelNotification(42);

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

Annuler toutes les notifications

await LocalNotification.cancelAllNotifications();

Effacer le compteur de badges

await LocalNotification.clearBadgeCount();

Permissions

Demandez les permissions de notification a l'utilisateur :

// 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',
);

Les permissions sont automatiquement demandees lors du premier envoi de notification via NyScheduler.taskOnce.

Configuration de la plateforme

Configuration iOS

Ajoutez a votre Info.plist :

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

Configuration Android

Ajoutez a votre AndroidManifest.xml :

<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" />

Reference API

Methodes statiques

Methodes d'instance (chainables)