ios_local_notification 1.0.0

Send local notifications on iOS.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# ios_local_notification

[![Crates.io](https://img.shields.io/crates/v/ios_local_notification.svg)](https://crates.io/crates/ios_local_notification)
[![Docs.rs](https://docs.rs/ios_local_notification/badge.svg)](https://docs.rs/ios_local_notification)
[![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](#license)

Send **local notifications on iOS** directly from Rust, powered by [swift-rs](https://crates.io/crates/swift-rs).

⚠️ **Platform support**: This crate works **only on iOS**.  
Android or other platforms are **not supported**.

## ✨ Features

- Request notification permissions (default or with fine-grained options).
- Schedule one-time, repeating, or image-based notifications.
- Clear pending or delivered notifications.
- Remove notifications by identifier.
- Retrieve lists of pending or delivered notifications.

## 📦 Installation

`cargo add ios_local_notification`

## 🚀 Usage

```rust
use ios_local_notification as notif;

fn main() {
    // Request permission with default options (all perms)
    notif::request_permission_default();

    // Or request custom permissions
    notif::request_permission(
        notif::permission::ALERT | notif::permission::SOUND,
    );

    // Schedule a notification after 5 seconds
    notif::schedule("welcome", "Hello!", "This is your first notification 🚀", 5);

    // Schedule a repeating notification
    notif::schedule_repeat("ping", "Reminder", "This repeats every 10s", 10);

    // Schedule with an image attachment
    notif::schedule_image("img1", "Picture!", "With an image", "example.png", 5);

    // Query notifications
    let pending = notif::pending_notifications();
    let delivered = notif::delivered_notifications();
    println!("Pending: {:?}", pending);
    println!("Delivered: {:?}", delivered);

    // Remove a specific notification
    notif::remove_by_id("welcome");

    // Clear all notifications
    notif::clear_all_pending();
    notif::clear_all_delivered();
}
```

## 🔑 Permissions

You can request granular permissions using bitflags from `permission`:
```rust
use ios_local_notification::permission;

notif::request_permission(permission::ALERT | permission::SOUND);
```

Available flags:
+ ALERT → Show banners and alerts
+ SOUND → Play notification sounds
+ BADGE → Set app badge number
+ CARPLAY → Show notifications in CarPlay
+ CRITICAL_ALERT → Bypass Do Not Disturb
+ PROVISIONAL → Deliver quietly without user prompt

## 📚 Documentation

👉 Read the full API docs on [docs.rs](https://docs.rs/ios_local_notification)