开源项目 `aritchie/notifications` 使用教程

开源项目 aritchie/notifications 使用教程

notificationsLocal notifications for iOS, Android, & Windows. Includes badges, scheduled notifications, sounds, & context actions项目地址:https://gitcode.com/gh_mirrors/notific/notifications

1. 项目的目录结构及介绍

notifications/
├── src/
│   ├── Notifications.Android/
│   ├── Notifications.iOS/
│   ├── Notifications.macOS/
│   ├── Notifications.Tizen/
│   ├── Notifications.UWP/
│   ├── Notifications.WPF/
│   ├── Notifications.Shared/
│   └── Notifications.Sample/
├── .gitignore
├── LICENSE
├── README.md
└── Notifications.sln
  • src/: 包含项目的所有源代码。
    • Notifications.Android/: Android 平台的通知实现。
    • Notifications.iOS/: iOS 平台的通知实现。
    • Notifications.macOS/: macOS 平台的通知实现。
    • Notifications.Tizen/: Tizen 平台的通知实现。
    • Notifications.UWP/: UWP 平台的通知实现。
    • Notifications.WPF/: WPF 平台的通知实现。
    • Notifications.Shared/: 共享代码,包含跨平台的逻辑。
    • Notifications.Sample/: 示例项目,展示如何使用通知库。
  • .gitignore: Git 忽略文件配置。
  • LICENSE: 项目许可证。
  • README.md: 项目说明文档。
  • Notifications.sln: 项目的解决方案文件。

2. 项目的启动文件介绍

Notifications.Sample 目录下,可以找到示例项目的启动文件。具体路径如下:

src/Notifications.Sample/
├── MainPage.xaml
├── MainPage.xaml.cs
├── App.xaml
└── App.xaml.cs
  • MainPage.xaml: 主页面的 XAML 文件,定义了页面的布局和样式。
  • MainPage.xaml.cs: 主页面的代码隐藏文件,包含页面的逻辑处理。
  • App.xaml: 应用程序的 XAML 文件,定义了应用程序的资源和样式。
  • App.xaml.cs: 应用程序的代码隐藏文件,包含应用程序的启动逻辑。

3. 项目的配置文件介绍

Notifications.Sample 目录下,可以找到示例项目的配置文件。具体路径如下:

src/Notifications.Sample/
├── App.xaml
├── App.xaml.cs
├── Notifications.Sample.csproj
└── Properties/
    └── AssemblyInfo.cs
  • App.xaml: 应用程序的 XAML 文件,定义了应用程序的资源和样式。
  • App.xaml.cs: 应用程序的代码隐藏文件,包含应用程序的启动逻辑。
  • Notifications.Sample.csproj: 示例项目的项目文件,包含了项目的配置信息和依赖项。
  • Properties/: 包含项目的属性文件。
    • AssemblyInfo.cs: 包含程序集的元数据信息,如版本号、作者等。

以上是 aritchie/notifications 开源项目的目录结构、启动文件和配置文件的介绍。通过这些信息,您可以更好地理解和使用该项目。

notificationsLocal notifications for iOS, Android, & Windows. Includes badges, scheduled notifications, sounds, & context actions项目地址:https://gitcode.com/gh_mirrors/notific/notifications

Onesignal API的参数和返回值如下: **参数:** - app_id (string, required):OneSignal应用程序的ID。 - contents (object, optional):通知的消息内容,可以是纯文本字符串或包含多个文本字段的对象。例如:`{"en": "English Message", "es": "Mensaje en español"}`。 - headings (object, optional):通知的消息标题,可以是纯文本字符串或包含多个文本字段的对象。例如:`{"en": "English Title", "es": "Título en español"}`。 - subtitle (object, optional):通知的消息副标题,可以是纯文本字符串或包含多个文本字段的对象。例如:`{"en": "English Subtitle", "es": "Subtítulo en español"}`。 - template_id (string, optional):使用OneSignal模板的ID,以自定义通知的外观和功能。 - included_segments (array, optional):要发送通知的用户的段列表。 - excluded_segments (array, optional):不要发送通知的用户的段列表。 - include_player_ids (array, optional):要发送通知的单个用户的ID列表。 - included_ios_badge_count (number, optional):在iOS上显示的徽章计数。 - android_channel_id (string, optional):在Android上使用的通知渠道的ID。 - small_icon (string, optional):在通知中使用的小图标的名称或资源ID。 - large_icon (string, optional):在通知中使用的大图标的名称或资源ID。 - big_picture (string, optional):在通知中使用的大图片的URL地址。 - buttons (array, optional):在通知中显示的按钮列表。每个按钮都包含文本和一个打开URL或执行操作的URL。 - web_buttons (array, optional):在浏览器中打开的按钮列表。每个按钮都包含文本和一个打开URL的URL。 - ios_attachments (object, optional):在iOS上使用的附件。可以是单个文件或多个文件的对象。例如:`{"id1": "https://example.com/image.png", "id2": "https://example.com/audio.mp3"}`。 - android_background_layout (object, optional):在Android上使用的后台布局。可以是纯文本字符串或包含多个文本字段的对象。例如:`{"headings_color": "FFFF0000", "contents_color": "FF00FF00"}`。 - ttl (number, optional):通知的生存时间(以秒为单位)。 - priority (number, optional):通知的优先级。值为-2、-1、0、1或2。 - sound (string, optional):要在通知中播放的声音的名称或资源ID。 - android_led_color (string, optional):在Android上使用的LED颜色。 - android_accent_color (string, optional):在Android上使用的强调颜色。 - android_visibility (number, optional):在Android上通知的可见性。值为0、1或-1。 - ios_sound (string, optional):要在iOS上播放的声音的名称或资源ID。 - ios_badgeType (string, optional):在iOS上使用的徽章类型。值为none、setTo、increment或decrement。 - ios_badgeCount (number, optional):在iOS上显示的徽章计数。 - ios_category (string, optional):在iOS上使用的通知类别。 - content_available (boolean, optional):指示是否应在iOS上启用静默通知。 - mutable_content (boolean, optional):指示是否应在iOS上启用可变通知。 - url (string, optional):在通知中包含的URL地址。 **返回值:** - id (string):通知的唯一ID。 - recipients (number):接收通知的用户数。 - errors (array):发送通知时出现的任何错误。每个错误都是一个字符串,包含出错的用户ID和错误描述。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

任彭安

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值