鸿蒙开发接口公共事件与通知：【@ohos.reminderAgent (后台代理提醒)】

最新推荐文章于 2024-05-31 16:47:45 发布
最新推荐文章于 2024-05-31 16:47:45 发布
阅读量566 收藏 13
点赞数 10
分类专栏： 鸿蒙 文章标签： harmonyos OpenHarmony 程序员 鸿蒙 鸿蒙开发 鸿蒙系统 嵌入式
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2301_76813281/article/details/139102198
版权

 后台代理提醒

本模块提供后台代理提醒的能力。

开发应用时，开发者可以调用后台提醒发布的接口创建定时提醒，包括倒计时、日历、闹钟三种提醒类型。使用后台代理提醒能力后，应用可以被冻结或退出，计时和弹出提醒的功能将被后台系统服务代理。

icon-note.gif

  说明：  本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import reminderAgent from'@ohos.reminderAgent';

开发前请熟悉鸿蒙开发指导文档：gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md点击或者复制转到。

reminderAgent.publishReminder

publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void

发布一个后台代理提醒，使用callback方式实现异步调用。

需要权限： ohos.permission.PUBLISH_AGENT_REMINDER

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
reminderReq[ReminderRequest]是需要发布的提醒实例。
callbackAsyncCallback<number>是异步回调，返回当前发布的提醒的reminderId。

示例：

  let timer = {
      reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
      triggerTimeInSeconds: 10
  }
  reminderAgent.publishReminder(timer, (err, reminderId) => {
      console.log("callback, reminderId = " + reminderId);
  });

reminderAgent.publishReminder

publishReminder(reminderReq: ReminderRequest): Promise<number>

发布一个后台代理提醒，使用Promise方式实现异步调用。

需要权限： ohos.permission.PUBLISH_AGENT_REMINDER

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
reminderReq[ReminderRequest]是需要发布的提醒实例。

返回值：

类型说明
Promise<number>返回提醒的reminderId。

示例：

  let timer = {
      reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
      triggerTimeInSeconds: 10
  }
  reminderAgent.publishReminder(timer).then((reminderId) => {
      console.log("promise, reminderId = " + reminderId);
  });

reminderAgent.cancelReminder

cancelReminder(reminderId: number, callback: AsyncCallback<void>): void

取消指定id的提醒，使用callback方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
reminderIdnumber是目标reminder的id号。
callbackAsyncCallback<void>是异步回调。

示例：

reminderAgent.cancelReminder(1, (err, data) => {
    console.log("cancelReminder callback");
});

reminderAgent.cancelReminder

cancelReminder(reminderId: number): Promise<void>

取消指定id的提醒，使用Promise方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
reminderIdnumber是目标reminder的id号。

返回值：

类型说明
Promise<void>Promise类型异步回调。

示例：

reminderAgent.cancelReminder(1).then(() => {
    console.log("cancelReminder promise");
});

reminderAgent.getValidReminders

getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void

获取当前应用已设置的所有有效（未过期）的提醒，使用callback方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
callbackAsyncCallback<Array<[ReminderRequest]>>是异步回调，返回当前应用已设置的所有有效（未过期）的提醒。

示例：

reminderAgent.getValidReminders((err, reminders) => {
    console.log("callback, getValidReminders length = " + reminders.length);
    for (let i = 0; i < reminders.length; i++) {
        console.log("getValidReminders = " + reminders[i]);
        console.log("getValidReminders, reminderType = " + reminders[i].reminderType);
        for (let j = 0; j < reminders[i].actionButton.length; j++) {
            console.log("getValidReminders, actionButton.title = " + reminders[i].actionButton[j].title);
            console.log("getValidReminders, actionButton.type = " + reminders[i].actionButton[j].type);
        }
        console.log("getValidReminders, wantAgent.pkgName = " + reminders[i].wantAgent.pkgName);
        console.log("getValidReminders, wantAgent.abilityName = " + reminders[i].wantAgent.abilityName);
        console.log("getValidReminders, maxScreenWantAgent.pkgName = " + reminders[i].maxScreenWantAgent.pkgName);
        console.log("getValidReminders, maxScreenWantAgent.abilityName = " + reminders[i].maxScreenWantAgent.abilityName);
        console.log("getValidReminders, ringDuration = " + reminders[i].ringDuration);
        console.log("getValidReminders, snoozeTimes = " + reminders[i].snoozeTimes);
        console.log("getValidReminders, timeInterval = " + reminders[i].timeInterval);
        console.log("getValidReminders, title = " + reminders[i].title);
        console.log("getValidReminders, content = " + reminders[i].content);
        console.log("getValidReminders, expiredContent = " + reminders[i].expiredContent);
        console.log("getValidReminders, snoozeContent = " + reminders[i].snoozeContent);
        console.log("getValidReminders, notificationId = " + reminders[i].notificationId);
        console.log("getValidReminders, slotType = " + reminders[i].slotType);
    }
})

reminderAgent.getValidReminders

getValidReminders(): Promise<Array<ReminderRequest>>

获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

返回值：

类型说明
Promise<Array<[ReminderRequest]>>返回当前应用已设置的所有有效（未过期）的提醒。

示例：

reminderAgent.getValidReminders().then((reminders) => {
    console.log("promise, getValidReminders length = " + reminders.length);
    for (let i = 0; i < reminders.length; i++) {
        console.log("getValidReminders = " + reminders[i]);
        console.log("getValidReminders, reminderType = " + reminders[i].reminderType);
        for (let j = 0; j < reminders[i].actionButton.length; j++) {
            console.log("getValidReminders, actionButton.title = " + reminders[i].actionButton[j].title);
            console.log("getValidReminders, actionButton.type = " + reminders[i].actionButton[j].type);
        }
        console.log("getValidReminders, wantAgent.pkgName = " + reminders[i].wantAgent.pkgName);
        console.log("getValidReminders, wantAgent.abilityName = " + reminders[i].wantAgent.abilityName);
        console.log("getValidReminders, maxScreenWantAgent.pkgName = " + reminders[i].maxScreenWantAgent.pkgName);
        console.log("getValidReminders, maxScreenWantAgent.abilityName = " + reminders[i].maxScreenWantAgent.abilityName);
        console.log("getValidReminders, ringDuration = " + reminders[i].ringDuration);
        console.log("getValidReminders, snoozeTimes = " + reminders[i].snoozeTimes);
        console.log("getValidReminders, timeInterval = " + reminders[i].timeInterval);
        console.log("getValidReminders, title = " + reminders[i].title);
        console.log("getValidReminders, content = " + reminders[i].content);
        console.log("getValidReminders, expiredContent = " + reminders[i].expiredContent);
        console.log("getValidReminders, snoozeContent = " + reminders[i].snoozeContent);
        console.log("getValidReminders, notificationId = " + reminders[i].notificationId);
        console.log("getValidReminders, slotType = " + reminders[i].slotType);
    }
})

reminderAgent.cancelAllReminders

cancelAllReminders(callback: AsyncCallback<void>): void

取消当前应用所有的提醒，使用callback方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
callbackAsyncCallback<void>是异步回调。

示例：

reminderAgent.cancelAllReminders((err, data) =>{
    console.log("cancelAllReminders callback")
})

reminderAgent.cancelAllReminders

cancelAllReminders(): Promise<void>

取消当前应用所有的提醒，使用Promise方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

返回值：

类型说明
Promise<void>Promise类型异步回调。

示例：

reminderAgent.cancelAllReminders().then(() => {
    console.log("cancelAllReminders promise")
})

reminderAgent.addNotificationSlot

addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void

添加一个NotificationSlot，使用callback方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
slot[NotificationSlot]是notification slot实例，仅支持设置其type属性。
callbackAsyncCallback<void>是异步回调。

示例：

import notification from '@ohos.notification'

let mySlot = {
    type: notification.SlotType.SOCIAL_COMMUNICATION
}
reminderAgent.addNotificationSlot(mySlot, (err, data) => {
    console.log("addNotificationSlot callback");
});

reminderAgent.addNotificationSlot

addNotificationSlot(slot: NotificationSlot): Promise<void>

添加一个NotificationSlot，使用Promise方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
slot[NotificationSlot]是notification slot实例，仅支持设置其type属性。

返回值：

类型说明
Promise<void>Promise类型异步回调。

示例：

import notification from '@ohos.notification'

let mySlot = {
    type: notification.SlotType.SOCIAL_COMMUNICATION
}
reminderAgent.addNotificationSlot(mySlot).then(() => {
   console.log("addNotificationSlot promise");
});

reminderAgent.removeNotificationSlot

removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void

删除目标NotificationSlot，使用callback方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
slotType[notification.SlotType]是目标notification slot的类型。
callbackAsyncCallback<void>是异步回调。

示例：

import notification from '@ohos.notification'

reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) => {
    console.log("removeNotificationSlot callback");
});

reminderAgent.removeNotificationSlot

removeNotificationSlot(slotType: notification.SlotType): Promise<void>

删除目标NotificationSlot，使用Promise方式实现异步调用。

系统能力： SystemCapability.Notification.ReminderAgent

参数：

参数名类型必填说明
slotType[notification.SlotType]是目标notification slot的类型。

返回值：

类型说明
Promise<void>Promise类型异步回调。

示例：

import notification from '@ohos.notification'

reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() => {
    console.log("removeNotificationSlot promise");
});

ActionButtonType

按钮的类型。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称默认值说明
ACTION_BUTTON_TYPE_CLOSE0表示关闭提醒的按钮。
ACTION_BUTTON_TYPE_SNOOZE1表示延迟提醒的按钮。

ReminderType

提醒的类型。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称默认值说明
REMINDER_TYPE_TIMER0表示提醒类型：倒计时。
REMINDER_TYPE_CALENDAR1表示提醒类型：日历。
REMINDER_TYPE_ALARM2表示提醒类型：闹钟。

ActionButton

用于设置弹出的提醒通知信息上显示的按钮类型和标题。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称参数类型必填说明
titlestring是按钮显示的标题。
type[ActionButtonType]是按钮的类型。

WantAgent

点击提醒通知后跳转的目标ability信息。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称参数类型必填说明
pkgNamestring是指明点击提醒通知栏后跳转的目标hap包名。
abilityNamestring是指明点击提醒通知栏后跳转的目标ability名称。

MaxScreenWantAgent

提醒到达时自动拉起的目标ability信息。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称参数类型必填说明
pkgNamestring是指明提醒到达时自动拉起的目标hap包名（如果设备在使用中，则只弹出通知横幅框）。
abilityNamestring是指明提醒到达时自动拉起的目标ability名（如果设备在使用中，则只弹出通知横幅框）。

ReminderRequest

提醒实例对象，用于设置提醒类型、响铃时长等具体信息。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称参数类型必填说明
reminderTypeReminderType是指明提醒类型。
actionButton[ActionButton?, ActionButton?]否弹出的提醒通知栏中显示的按钮（参数可选，支持0/1/2个按钮）。
wantAgentWantAgent否点击通知后需要跳转的目标ability信息。
maxScreenWantAgentMaxScreenWantAgent否提醒到达时跳转的目标包。如果设备正在使用中，则弹出一个通知框。
ringDurationnumber否指明响铃时长。
snoozeTimesnumber否指明延迟提醒次数。
timeIntervalnumber否执行延迟提醒间隔。
titlestring否指明提醒标题。
contentstring否指明提醒内容。
expiredContentstring否指明提醒过期后需要显示的内容。
snoozeContentstring否指明延迟提醒时需要显示的内容。
notificationIdnumber否指明提醒使用的通知的id号，相同id号的提醒会覆盖。
slotType[notification.SlotType]否指明提醒的slot类型。

ReminderRequestCalendar

ReminderRequestCalendar extends ReminderRequest

日历实例对象，用于设置提醒的时间。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称参数类型必填说明
dateTime[LocalDateTime]是指明提醒的目标时间。
repeatMonthsArray<number>否指明重复提醒的月份。
repeatDaysArray<number>否指明重复提醒的日期。

ReminderRequestAlarm

ReminderRequestAlarm extends ReminderRequest

闹钟实例对象，用于设置提醒的时间。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称参数类型必填说明
hournumber是指明提醒的目标时刻。
minutenumber是指明提醒的目标分钟。
daysOfWeekArray<number>否指明每周哪几天需要重复提醒。

ReminderRequestTimer

ReminderRequestTimer extends ReminderRequest

倒计时实例对象，用于设置提醒的时间。

系统能力：SystemCapability.Notification.ReminderAgent

名称参数类型必填说明 HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿
triggerTimeInSecondsnumber是指明倒计时的秒数。

搜狗高速浏览器截图20240326151547.png

LocalDateTime

用于日历类提醒设置时指定时间信息。

系统能力：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent

名称参数类型必填说明
yearnumber是年
monthnumber是月
daynumber是日
hournumber是时
minutenumber是分
secondnumber否秒

鸿蒙Next核心技术分享

1、鸿蒙基础知识←《鸿蒙NEXT星河版开发学习文档》

2、鸿蒙ArkUI←《鸿蒙NEXT星河版开发学习文档》

3、鸿蒙进阶技术←《鸿蒙NEXT星河版开发学习文档》

 4、鸿蒙就业高级技能←《鸿蒙NEXT星河版开发学习文档》 

 5、鸿蒙多媒体技术←《鸿蒙NEXT星河版开发学习文档》 

6、鸿蒙南向驱动开发←《鸿蒙NEXT星河版开发学习文档》  

7、鸿蒙南向内核设备开发←《鸿蒙NEXT星河版开发学习文档》  

 8、鸿蒙系统裁剪与移植←《鸿蒙NEXT星河版开发学习文档》  

爱桥代码的程序媛
关注
  • 10
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
HarmonyOS鸿蒙开发指南:基于ArkTS开发 公共事件与通知
sybh的博客
01-10 1418
HarmonyOS通过CES（Common Event Service，公共事件服务）为应用程序提供订阅、发布、退订公共事件的能力。公共事件可分为系统公共事件和自定义公共事件。系统公共事件：系统将收集到的事件信息，根据系统策略发送给订阅该事件的用户程序。例如：系统关键服务发布的系统事件（例如：hap安装，更新，卸载等）。自定义公共事件：应用自定义一些公共事件用来实现跨应用的事件通信能力。每个应用都可以按需订阅公共事件，订阅成功且公共事件发布，系统会把其发送给应用。
HarmonyOS @ohos.net.http 网络GET、POST请求封装
04-16
HarmonyOS @ohos.net.http 网络GET、POST请求封装
＜HarmonyOS第一课＞给应用添加通知和提醒
qq_41881317的博客
12-21 143
随着生活节奏的加快，我们有时会忘记一些重要的事情或日子，所以提醒功能必不可少。应用可能需要在指定的时刻，向用户发送一些业务提醒通知。例如购物类应用，希望在指定时间点提醒用户有优惠活动。为满足此类业务诉求，HarmonyOS提供后台代理提醒功能，在应用退居后台或退出后，计时和提醒通知功能被系统后台代理接管。倒计时类：基于倒计时的提醒功能，适用于短时的计时提醒业务。日历类：基于日历的提醒功能，适用于较长时间的提醒业务。闹钟类：基于时钟的提醒功能，适用于指定时刻的提醒业务。
harmonyOS鸿蒙官网教程-后台代理提醒
移动端开发与最新技术
10-08 374
随着生活节奏的加快，我们有时会忘记一些重要的事情或日子，所以提醒功能必不可少。应用可能需要在指定的时刻，向用户发送一些业务提醒通知。例如购物类应用，希望在指定时间点提醒用户有优惠活动。为满足此类业务诉求，HarmonyOS提供后台代理提醒功能，在应用退居后台或退出后，计时和提醒通知功能被系统后台代理接管。
HarmonyOS4.0从零开始的开发教程18后台代理提醒
qq_46189388的博客
12-17 1362
等能力。后台代理提醒服务提供统一的提醒管理能力，在应用退居后台或退出后，计时和提醒通知功能被系统后台代理接管。以新增一个9点的喝水提醒为例：假设用户在8点新增这个喝水提醒，应用根据用户设置的信息生成提醒实例并发布提醒。由后台代理提醒服务调用系统服务启动计时。到9点时，系统唤醒后台代理提醒服务发布通知，最终由通知服务触发桌面显示通知。
HarmonyOS鸿蒙应用开发( 四、重磅组件List列表组件使用详解)
独行猫a 的沉淀、积累、总结。天天学习，好好向上...c/c++,嵌入式 linux,Android,HarmonyOS)
01-23 3737
List列表组件，是一个非常常用且重要的组件。可以说在一个应用中，它的身影无处不在。它包含一系列相同宽度的列表项，适合连续、多行呈现同类数据，例如图片列表和和文本列表等。ArkUI 框架采用 List 容器创建列表（类似 Android 的 RecycleView、Compose 的 LazyColumn）。
HarmonyOS开发(十)：通知和提醒
advent86的专栏
12-06 1593
应用可以通过通知接口发送通知消息，终端用户可以通过通知栏查看通知内容，也可以点击通知来打开应用。HarmonyOS通过ANS(Advanced Notification Service,通知系统服务)对通知消息进行管理，支持多种通知类型。
鸿蒙HarmonyOS 开发通过 @BuilderParam装饰器：引用@Builder函数实现自定义标题栏
02-22
鸿蒙HarmonyOS 开发通过 @BuilderParam装饰器：引用@Builder函数实现自定义标题栏
华为鸿蒙HarmonyOS开发整理资料汇总.zip
11-25
华为鸿蒙HarmonyOS开发整理资料汇总，共38份。 1学前必读：HarmonyOS学习资源主题分享 2学前必读：OpenHarmony-联盟生态资料合集 3-1.HarmonyOS概述：技术特性 3-2.HarmonyOS概述：开发工具与平台 3-3.HarmonyOS...
HarmonyOS Ability 公共事件与通知1
08-08
公共事件与通知HarmonyOS通过CES（Common Event Service，公共事件服务）为应用程序提供订阅、发布、退订公共事件的能力，通过ANS（A
华为鸿蒙HarmonyOS开发者资料大全鸿蒙系统开发资料汇总.zip
06-16
鸿蒙HarmonyOS开发者资料大全鸿蒙系统开发资料汇总,包括如下： DevEco Studio 1.0 使用指南.pdf HarmonyOS-NFC开发指南.pdf HarmonyOS应用开发之页面开发.pdf HarmonyOS开发必备基础知识.pdf WLAN开发指南.pdf 图像...
鸿蒙OS 路由跳转
程序员—威廉
05-22 397
2. **调用`Router`对象的`replace`或`push`方法**：在需要执行跳转的地方，调用`Router`对象的`replace`或`push`方法，并传入目标页面的路由路径。3. **使用`AbilitySlice`的`start`方法**：在自定义组件中，可以使用`AbilitySlice`的`start`方法来启动一个新的页面。1. **使用`@Route`装饰器**：在需要跳转的页面上添加`@Route`装饰器，并指定一个唯一的路由路径。）中定义路由路径，并指定参数。
JavaScript、Kotlin、Flutter可以开发鸿蒙APP吗？
finogeeks的博客
05-30 1168
作为反内卷达人，作者今天想分享的是：不学习ArkTS语言，我们应该怎么开发鸿蒙app！
HarmonyOS鸿蒙学习笔记（28）@entry和@Component的生命周期
最新发布
菜鸟博客
05-31 930
@entry和@Component的生命周期
HarmonyOS-9(stage模式)
xueyoubangbang的博客
05-29 276
【代码】HarmonyOS-9(stage模式)
【HarmonyOS】取消页面转场动画
我的小窝
05-29 422
取消页面转场动画
鸿蒙应用Stage模型【应用/组件级配置】
m0_70748845的博客
05-30 773
在开发应用时，需要配置应用的一些标签，例如应用的包名、图标等标识特征的属性。本文描述了在开发应用需要配置的一些关键标签。
关于鸿蒙系统对比安卓系统的优势？
m0_68038853的博客
05-29 911
鸿蒙操作系统具备跨平台能力，可以在不同类型的设备上运行，例如智能手机、平板电脑、智能穿戴设备、智能家居设备等。这意味着开发人员可以使用同一套代码或开发工具来开发应用程序，然后在多种不同类型的设备上运行。这样可以提高开发效率和应用程序的兼容性。跨设备通常指的是鸿蒙操作系统在不同种类的设备之间实现连接和协作，使得这些设备能够共享数据、通信或协同工作。通过鸿蒙操作系统的跨设备能力，用户可以在不同的鸿蒙设备之间实现无缝的体验，例如在智能手机和智能家居设备之间共享数据或控制家居设备等。
npm ERR! 400 Bad Request - GET https://repo.harmonyos.com/npm/@ohos%2fhpm-cli
03-24
我不确定这个问题的上下文，请问您能否提供更多的信息？是在使用 npm 安装 @ohos/hpm-cli 时遇到了错误码为 400 的 Bad Request 错误吗？可能是您的请求不符合服务器的要求，请检查您的网络连接和相关配置，或者尝试使用其他方式安装。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值