1# 后台代理提醒开发指导 2 3 4## 接口说明 5 6后台代理提醒功能主要提供后台提醒通知发布接口，开发者可调用这些接口创建定时提醒，包括倒计时、日历、闹钟三种提醒类型。[reminderAgentManager](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md)封装了发布、取消提醒通知的方法。 7 8 **表1** reminderAgentManager主要接口 9 10| 接口名 | 描述 | 11| ---------------------------------------- | ---------------------------------------- | 12| publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void<br/>publishReminder(reminderReq: ReminderRequest): Promise<number> | 发布一个定时提醒类通知。<br/>- 单个应用有效的提醒个数最多支持30个（不包括已经超时，即后续不会再提醒的提醒实例）。<br/>- 整个系统有效的提醒个数最多支持2000个（不包括已经超时，即后续不会再提醒的提醒实例）。 | 13| cancelReminder(reminderId: number, callback: AsyncCallback<void>): void<br/>cancelReminder(reminderId: number): Promise<void> | 取消一个指定的提醒类通知（reminderId从publishReminder的返回值获取）。 | 14| getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void<br/>getValidReminders(): Promise<Array<ReminderRequest>> | 获取当前应用设置的所有有效的提醒。 | 15| cancelAllReminders(callback: AsyncCallback<void>): void<br/>cancelAllReminders(): Promise<void> | 取消当前应用设置的所有提醒。 | 16| addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void<br/>addNotificationSlot(slot: NotificationSlot): Promise<void> | 注册一个提醒类需要使用的NotificationSlot。 | 17| removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void<br/>removeNotificationSlot(slotType: notification.SlotType): Promise<void> | 删除指定类型的NotificationSlot。 | 18 19 20## 开发步骤 21 221. 申请`ohos.permission.PUBLISH_AGENT_REMINDER`权限，配置方式请参阅[访问控制授权申请指导](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-guidelines.md#stage%E6%A8%A1%E5%9E%8B)。 23 242. [使能通知开关](../notification/notification-enable.md)，获得用户授权后，才能使用代理提醒功能。 25 263. 导入模块。 27 28 ```js 29 import reminderAgentManager from '@ohos.reminderAgentManager'; 30 import NotificationManager from '@ohos.notificationManager'; 31 ``` 32 334. 定义目标提醒代理。开发者根据实际需要，选择定义如下类型的提醒。 34 - 定义倒计时实例。 35 36 ```js 37 let targetReminderAgent: reminderAgentManager.ReminderRequestTimer = { 38 reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_TIMER, // 提醒类型为倒计时类型 39 triggerTimeInSeconds: 10, 40 actionButton: [ // 设置弹出的提醒通知信息上显示的按钮类型和标题，支持“关闭”和“延迟”两种类型，其中“延迟”按钮类型需要与snoozeTimes和timeInterval参数结合使用 41 { 42 title: 'close', 43 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE 44 } 45 ], 46 wantAgent: { // 点击提醒通知后跳转的目标UIAbility信息 47 pkgName: 'com.example.myapplication', 48 abilityName: 'EntryAbility' 49 }, 50 maxScreenWantAgent: { // 全屏显示提醒到达时自动拉起的目标Ability信息 51 pkgName: 'com.example.myapplication', 52 abilityName: 'EntryAbility' 53 }, 54 title: 'this is title', // 指明提醒标题 55 content: 'this is content', // 指明提醒内容 56 expiredContent: 'this reminder has expired', // 指明提醒过期后需要显示的内容 57 notificationId: 100, // 指明提醒使用的通知的ID号，相同ID号的提醒会覆盖 58 slotType: NotificationManager.SlotType.SOCIAL_COMMUNICATION // 指明提醒的Slot类型 59 } 60 ``` 61 - 定义日历实例。 62 63 ```js 64 let targetReminderAgent: reminderAgentManager.ReminderRequestCalendar = { 65 reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_CALENDAR, // 提醒类型为日历类型 66 dateTime: { // 指明提醒的目标时间 67 year: 2023, 68 month: 7, 69 day: 30, 70 hour: 11, 71 minute: 14, 72 second: 30 73 }, 74 repeatMonths: [1], // 指明重复提醒的月份 75 repeatDays: [1], // 指明重复提醒的日期 76 actionButton: [ // 设置弹出的提醒通知信息上显示的按钮类型和标题，支持“关闭”和“延迟”两种类型，其中“延迟”按钮类型需要与snoozeTimes和timeInterval参数结合使用 77 { 78 title: 'close', 79 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE 80 }, 81 { 82 title: 'snooze', 83 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE 84 }, 85 ], 86 wantAgent: { // 点击提醒通知后跳转的目标UIAbility信息 87 pkgName: 'com.example.myapplication', 88 abilityName: 'EntryAbility' 89 }, 90 maxScreenWantAgent: { // 点击提醒通知后跳转的目标UIAbility信息 91 pkgName: 'com.example.myapplication', 92 abilityName: 'EntryAbility' 93 }, 94 ringDuration: 5, // 指明响铃时长（单位：秒） 95 snoozeTimes: 2, // 指明延迟提醒次数 96 timeInterval: 5, // 执行延迟提醒间隔（单位：秒） 97 title: 'this is title', // 指明提醒标题 98 content: 'this is content', // 指明提醒内容 99 expiredContent: 'this reminder has expired', // 指明提醒过期后需要显示的内容 100 snoozeContent: 'remind later', // 指明延迟提醒时需要显示的内容 101 notificationId: 100, // 指明提醒使用的通知的ID号，相同ID号的提醒会覆盖 102 slotType: NotificationManager.SlotType.SOCIAL_COMMUNICATION // 指明提醒的Slot类型 103 } 104 ``` 105 - 定义闹钟实例。 106 107 ```js 108 let targetReminderAgent: reminderAgentManager.ReminderRequestAlarm = { 109 reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_ALARM, // 提醒类型为闹钟类型 110 hour: 23, // 指明提醒的目标时刻 111 minute: 9, // 指明提醒的目标分钟 112 daysOfWeek: [2], // 指明每周哪几天需要重复提醒 113 actionButton: [ // 设置弹出的提醒通知信息上显示的按钮类型和标题，支持“关闭”和“延迟”两种类型，其中“延迟”按钮类型需要与snoozeTimes和timeInterval参数结合使用 114 { 115 title: 'close', 116 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE 117 }, 118 { 119 title: 'snooze', 120 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE 121 }, 122 ], 123 wantAgent: { // 点击提醒通知后跳转的目标UIAbility信息 124 pkgName: 'com.example.myapplication', 125 abilityName: 'EntryAbility' 126 }, 127 maxScreenWantAgent: { // 点击提醒通知后跳转的目标UIAbility信息 128 pkgName: 'com.example.myapplication', 129 abilityName: 'EntryAbility' 130 }, 131 ringDuration: 5, // 指明响铃时长（单位：秒） 132 snoozeTimes: 2, // 指明延迟提醒次数 133 timeInterval: 5, // 执行延迟提醒间隔（单位：秒） 134 title: 'this is title', // 指明提醒标题 135 content: 'this is content', // 指明提醒内容 136 expiredContent: 'this reminder has expired', // 指明提醒过期后需要显示的内容 137 snoozeContent: 'remind later', // 指明延迟提醒时需要显示的内容 138 notificationId: 99, // 指明提醒使用的通知的ID号，相同ID号的提醒会覆盖 139 slotType: NotificationManager.SlotType.SOCIAL_COMMUNICATION // 指明提醒的Slot类型 140 } 141 ``` 142 1435. 发布相应的提醒代理。代理发布后，应用即可使用后台代理提醒功能。 144 145 ```js 146 try { 147 reminderAgentManager.publishReminder(targetReminderAgent).then(res => { 148 console.info('publishReminder promise reminderId: ' + res); 149 let reminderId: number = res; 150 // ... 151 }).catch(err => { 152 console.info('publishReminder err code: ' + err.code + ' message:' + err.message); 153 }) 154 } catch (error) { 155 console.info('publishReminder code: ' + error.code + ' message:' + error.message); 156 } 157 ``` 158 159 以闹钟为例，运行效果如下图所示。 160 161  162 1636. 若需要删除提醒任务，可以通过调用[reminderAgentManager.cancelReminder()](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md#reminderagentmanagercancelreminder)方法来实现。 164 165 ```js 166 let reminderId = 0; // reminderId的值从发布提醒代理成功之后的回调中获得 167 168 try { 169 reminderAgentManager.cancelReminder(reminderId).then(() => { 170 console.log("cancelReminder promise"); 171 }).catch(err => { 172 console.log("promise err code: " + err.code + ", message:" + err.message); 173 }); 174 } catch (error) { 175 console.log("cancelReminder code: " + error.code + ", message: " + error.message); 176 }; 177 ``` 178 179## 相关实例 180 181基于后台代理提醒的开发，有以下相关实例可供参考： 182 183- [闹钟（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/CommonEventAndNotification/AlarmClock)
