Push Notifications

• Introduction
• Usage
  • Basic Usage
  • Scheduled Notifications
  • Customizing Notifications
  • Platform Specific Features
• Managing Notifications
  • Canceling Notifications
  • Requesting Permissions
• Platform Setup
• Available Methods
• API Reference
  • Main Properties
  • Android Specific Properties
  • iOS Specific Properties

Introduction

The Push Notification system in Nylo provides a powerful way to send local notifications to users. This feature allows you to send immediate or scheduled notifications with rich content and customizable behaviors for both iOS and Android platforms.

Basic Usage

Here's how to send a basic push notification:

// Simple notification
await PushNotification(
  title: "Hello",
  body: "This is a basic notification"
).send();

// Using the helper function
await pushNotification("Hello", "This is a basic notification").send();

// Using the static method
await PushNotification.sendNotification(
  title: "Hello",
  body: "This is a basic notification"
);

Scheduled Notifications

You can schedule notifications to be delivered at a specific time:

// Schedule a notification for tomorrow
final tomorrow = DateTime.now().add(Duration(days: 1));
await PushNotification(
  title: "Reminder",
  body: "Don't forget your appointment!"
).send(at: tomorrow);

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

Customizing Notifications

Adding Attachments

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

Setting Priority and Importance

await PushNotification(
  title: "Urgent Message",
  body: "This is important!"
)
  .addPriority(Priority.high)
  .addImportance(Importance.max)
  .send();

Adding Actions

final actions = [
  AndroidNotificationAction(
    'accept',
    'Accept',
    showsUserInterface: true,
  ),
  AndroidNotificationAction(
    'decline',
    'Decline',
    showsUserInterface: true,
  ),
];

await PushNotification(
  title: "Meeting Request",
  body: "Would you like to attend?"
)
  .addActions(actions)
  .send();

Platform Specific Features

iOS Specific Features

await PushNotification(
  title: "iOS Notification",
  body: "This is an iOS specific notification"
)
  .addBadgeNumber(1)
  .addSound("custom_sound.wav")
  .addThreadIdentifier("thread_1")
  .addInterruptionLevel(InterruptionLevel.active)
  .send();

Android Specific Features

await PushNotification(
  title: "Android Notification",
  body: "This is an Android specific notification"
)
  .addChannelId("custom_channel")
  .addChannelName("Custom Channel")
  .addChannelDescription("Notifications from custom channel")
  .addVibrationPattern([0, 1000, 500, 1000])
  .addLedColor(Color(0xFF00FF00))
  .send();

Managing Notifications

You can cancel specific notifications or all notifications, as well as request permissions for notifications.

Canceling Notifications

// Cancel a specific notification
await PushNotification.cancelNotification(1);

// Cancel all notifications
await PushNotification.cancelAllNotifications();

Requesting Permissions

// Request basic permissions
await PushNotification.requestPermissions();

// Request specific permissions
await PushNotification.requestPermissions(
  alert: true,
  badge: true,
  sound: true,
  provisional: false,
  critical: false,
  vibrate: true
);

Platform Setup

iOS Setup

1. Add the following to your Info.plist:

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

Android Setup

1. Add the following permissions to your 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" />

Available Methods

General Methods

Channel Configuration Methods

Visual Customization Methods

Behavior Configuration Methods

Progress Indicator Methods

LED Configuration Methods

iOS Specific Methods

Android Specific Methods

API Reference

This section provides a reference for the properties and methods available for the PushNotification class.

Main Properties

Android Specific Properties

iOS Specific Properties