Notifikasi Lokal

Pengantar

Nylo Website menyediakan sistem notifikasi lokal melalui class LocalNotification. Ini memungkinkan Anda mengirim notifikasi segera atau terjadwal dengan konten kaya di iOS dan Android.

Notifikasi lokal tidak didukung di web. Mencoba menggunakannya di web akan melempar NotificationException.

Penggunaan Dasar

Kirim notifikasi menggunakan pola builder atau metode statis:

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

Notifikasi Terjadwal

Jadwalkan notifikasi untuk dikirim pada waktu tertentu:

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

Pola Builder

Class LocalNotification menyediakan API builder yang lancar. Semua metode berantai mengembalikan 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();

Metode Berantai

send()

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

Jika at diberikan, jadwalkan notifikasi untuk waktu tersebut. Jika tidak, tampilkan segera.

Konfigurasi Platform

Opsi khusus platform dikonfigurasi melalui objek AndroidNotificationConfig dan IOSNotificationConfig.

Konfigurasi Android

Berikan AndroidNotificationConfig ke 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();

Properti AndroidNotificationConfig

Konfigurasi iOS

Berikan IOSNotificationConfig ke 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();

Properti IOSNotificationConfig

Lampiran (Khusus iOS)

Tambahkan lampiran gambar, audio, atau video ke notifikasi iOS. Lampiran diunduh dari URL:

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

Mengelola Notifikasi

Membatalkan Notifikasi Tertentu

await LocalNotification.cancelNotification(42);

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

Membatalkan Semua Notifikasi

await LocalNotification.cancelAllNotifications();

Menghapus Jumlah Badge

await LocalNotification.clearBadgeCount();

Izin

Minta izin notifikasi dari pengguna:

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

Izin secara otomatis diminta pada pengiriman notifikasi pertama melalui NyScheduler.taskOnce.

Pengaturan Platform

Pengaturan iOS

Tambahkan ke Info.plist Anda:

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

Pengaturan Android

Tambahkan ke AndroidManifest.xml Anda:

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

Referensi API

Metode Statis

Metode Instance (Berantai)