Notifiche Locali

Introduzione

Nylo Website fornisce un sistema di notifiche locali attraverso la classe LocalNotification. Questo ti permette di inviare notifiche immediate o programmate con contenuti ricchi su iOS e Android.

Le notifiche locali non sono supportate sul web. Il tentativo di usarle sul web generera' un NotificationException.

Utilizzo Base

Invia una notifica usando il pattern builder o il metodo statico:

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

Notifiche Programmate

Programma una notifica da consegnare a un orario specifico:

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

Pattern Builder

La classe LocalNotification fornisce un'API builder fluente. Tutti i metodi concatenabili restituiscono l'istanza 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();

Metodi Concatenabili

send()

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

Se at e' fornito, programma la notifica per quell'orario. Altrimenti la mostra immediatamente.

Configurazione della Piattaforma

Le opzioni specifiche della piattaforma sono configurate tramite gli oggetti AndroidNotificationConfig e IOSNotificationConfig.

Configurazione Android

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

Proprieta' di AndroidNotificationConfig

Configurazione iOS

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

Proprieta' di IOSNotificationConfig

Allegati (Solo iOS)

Aggiungi allegati immagine, audio o video alle notifiche iOS. Gli allegati vengono scaricati da un URL:

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

Gestione delle Notifiche

Annullare una Notifica Specifica

await LocalNotification.cancelNotification(42);

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

Annullare Tutte le Notifiche

await LocalNotification.cancelAllNotifications();

Cancellare il Conteggio dei Badge

await LocalNotification.clearBadgeCount();

Permessi

Richiedi i permessi per le notifiche all'utente:

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

I permessi vengono richiesti automaticamente al primo invio di notifica tramite NyScheduler.taskOnce.

Configurazione della Piattaforma

Configurazione iOS

Aggiungi al tuo Info.plist:

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

Configurazione Android

Aggiungi al tuo 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" />

Riferimento API

Metodi Statici

Metodi di Istanza (Concatenabili)