1# 代理提醒 2 3## 概述 4 5### 功能介绍 6 7应用退到后台或进程终止后，仍然有一些提醒用户的定时类任务，例如购物类应用抢购提醒等，为满足此类功能场景，系统提供了代理提醒（reminderAgentManager）的能力。当应用退至后台或进程终止后，系统会代理应用做相应的提醒。当前支持的提醒类型包括：倒计时、日历和闹钟。 8 9- 倒计时类：基于倒计时的提醒功能。 10 11- 日历类：基于日历的提醒功能。 12 13- 闹钟类：基于时钟的提醒功能。 14 15> **说明：** 16> 17> 闹钟类提醒，暂时仅支持横幅通知，无声音提示。 18 19### 约束与限制 20 21- **个数限制**：一个三方应用支持最多30个有效提醒（有效即发布成功），一个系统应用支持最多10000个有效提醒，整个系统最多支持12000个有效提醒。 22 23- **跳转限制**：点击提醒通知后跳转的应用必须是申请代理提醒的本应用。 24 25 26## 接口说明 27 28**表1** 主要接口 29 30以下是代理提醒的相关接口，下表均以Promise形式为例，更多接口及使用方式请见[后台代理提](../reference/apis/js-apis-reminderAgentManager.md)文档。 31| 接口名 | 描述 | 32| -------- | -------- | 33| publishReminder(reminderReq: ReminderRequest): Promise<number> | 发布一个定时提醒类通知 | 34| cancelReminder(reminderId: number): Promise<void> | 取消一个指定的提醒类通知 | 35| getValidReminders(): Promise<Array<ReminderRequest>> | 获取当前应用设置的所有有效的提醒 | 36| cancelAllReminders(): Promise<void> | 取消当前应用设置的所有提醒 | 37| addNotificationSlot(slot: NotificationSlot): Promise<void> | 注册一个提醒类需要使用的通知通道（NotificationSlot） | 38| removeNotificationSlot(slotType: notification.SlotType): Promise<void> | 删除指定的通知通道（NotificationSlot） | 39 40 41## 开发步骤 42 431. 申请ohos.permission.PUBLISH_AGENT_REMINDER权限，配置方式请参阅[配置文件权限声明](../security/accesstoken-guidelines.md#配置文件权限声明)。 44 452. [使能通知开关](../notification/notification-enable.md)。获得用户授权后，才能使用代理提醒功能。 46 473. 导入模块。 48 49 ```ts 50 import reminderAgentManager from '@ohos.reminderAgentManager'; 51 import notificationManager from '@ohos.notificationManager'; 52 import { BusinessError } from '@ohos.base'; 53 ``` 54 554. 定义目标提醒代理。开发者根据实际需要，选择定义如下类型的提醒。 56 57 - 定义倒计时实例。 58 59 ```ts 60 let targetReminderAgent: reminderAgentManager.ReminderRequestTimer = { 61 reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_TIMER, // 提醒类型为倒计时类型 62 triggerTimeInSeconds: 10, 63 actionButton: [ // 设置弹出的提醒通知信息上显示的按钮类型和标题 64 { 65 title: 'close', 66 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE 67 } 68 ], 69 wantAgent: { // 点击提醒通知后跳转的目标UIAbility信息 70 pkgName: 'com.example.myapplication', 71 abilityName: 'EntryAbility' 72 }, 73 maxScreenWantAgent: { // 全屏显示提醒到达时自动拉起的目标UIAbility信息 74 pkgName: 'com.example.myapplication', 75 abilityName: 'EntryAbility' 76 }, 77 title: 'this is title', // 指明提醒标题 78 content: 'this is content', // 指明提醒内容 79 expiredContent: 'this reminder has expired', // 指明提醒过期后需要显示的内容 80 notificationId: 100, // 指明提醒使用的通知的ID号，相同ID号的提醒会覆盖 81 slotType: notificationManager.SlotType.SOCIAL_COMMUNICATION // 指明提醒的Slot类型 82 } 83 ``` 84 85 - 定义日历实例。 86 87 ```ts 88 let targetReminderAgent: reminderAgentManager.ReminderRequestCalendar = { 89 reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_CALENDAR, // 提醒类型为日历类型 90 dateTime: { // 指明提醒的目标时间 91 year: 2023, 92 month: 1, 93 day: 1, 94 hour: 11, 95 minute: 14, 96 second: 30 97 }, 98 repeatMonths: [1], // 指明重复提醒的月份 99 repeatDays: [1], // 指明重复提醒的日期 100 actionButton: [ // 设置弹出的提醒通知信息上显示的按钮类型和标题 101 { 102 title: 'close', 103 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE 104 }, 105 { 106 title: 'snooze', 107 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE 108 }, 109 ], 110 wantAgent: { // 点击提醒通知后跳转的目标UIAbility信息 111 pkgName: 'com.example.myapplication', 112 abilityName: 'EntryAbility' 113 }, 114 maxScreenWantAgent: { // 全屏显示提醒到达时自动拉起的目标UIAbility信息 115 pkgName: 'com.example.myapplication', 116 abilityName: 'EntryAbility' 117 }, 118 ringDuration: 5, // 指明响铃时长（单位：秒） 119 snoozeTimes: 2, // 指明延迟提醒次数 120 timeInterval: 5, // 执行延迟提醒间隔（单位：秒） 121 title: 'this is title', // 指明提醒标题 122 content: 'this is content', // 指明提醒内容 123 expiredContent: 'this reminder has expired', // 指明提醒过期后需要显示的内容 124 snoozeContent: 'remind later', // 指明延迟提醒时需要显示的内容 125 notificationId: 100, // 指明提醒使用的通知的ID号，相同ID号的提醒会覆盖 126 slotType: notificationManager.SlotType.SOCIAL_COMMUNICATION // 指明提醒的Slot类型 127 } 128 ``` 129 130 - 定义闹钟实例。 131 132 ```ts 133 let targetReminderAgent: reminderAgentManager.ReminderRequestAlarm = { 134 reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_ALARM, // 提醒类型为闹钟类型 135 hour: 23, // 指明提醒的目标时刻 136 minute: 9, // 指明提醒的目标分钟 137 daysOfWeek: [2], // 指明每周哪几天需要重复提醒 138 actionButton: [ // 设置弹出的提醒通知信息上显示的按钮类型和标题 139 { 140 title: 'close', 141 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE 142 }, 143 { 144 title: 'snooze', 145 type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE 146 }, 147 ], 148 wantAgent: { // 点击提醒通知后跳转的目标UIAbility信息 149 pkgName: 'com.example.myapplication', 150 abilityName: 'EntryAbility' 151 }, 152 maxScreenWantAgent: { // 全屏显示提醒到达时自动拉起的目标UIAbility信息 153 pkgName: 'com.example.myapplication', 154 abilityName: 'EntryAbility' 155 }, 156 ringDuration: 5, // 指明响铃时长（单位：秒） 157 snoozeTimes: 2, // 指明延迟提醒次数 158 timeInterval: 5, // 执行延迟提醒间隔（单位：秒） 159 title: 'this is title', // 指明提醒标题 160 content: 'this is content', // 指明提醒内容 161 expiredContent: 'this reminder has expired', // 指明提醒过期后需要显示的内容 162 snoozeContent: 'remind later', // 指明延迟提醒时需要显示的内容 163 notificationId: 99, // 指明提醒使用的通知的ID号，相同ID号的提醒会覆盖 164 slotType: notificationManager.SlotType.SOCIAL_COMMUNICATION // 指明提醒的Slot类型 165 } 166 ``` 167 1685. 发布相应的提醒代理。代理发布后，应用即可使用后台代理提醒功能。 169 170 ```ts 171 reminderAgentManager.publishReminder(targetReminderAgent).then((res: number) => { 172 console.info('Succeeded in publishing reminder. '); 173 let reminderId: number = res; // 发布的提醒ID 174 }).catch((err: BusinessError) => { 175 console.error(`Failed to publish reminder. Code: ${err.code}, message: ${err.message}`); 176 }) 177 ``` 178 1796. 根据需要删除提醒任务。 180 181 ```ts 182 let reminderId: number = 1; 183 // reminderId的值从发布提醒代理成功之后的回调中获得 184 reminderAgentManager.cancelReminder(reminderId).then(() => { 185 console.log('Succeeded in canceling reminder.'); 186 }).catch((err: BusinessError) => { 187 console.error(`Failed to cancel reminder. Code: ${err.code}, message: ${err.message}`); 188 }); 189 ``` 190 191## 相关实例 192 193基于代理提醒，有以下相关实例可供参考： 194 195- [后台代理提醒（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-4.0-Release/code/BasicFeature/TaskManagement/ReminderAgentManager) 196 197- [翻页闹钟（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-4.0-Release/code/Solutions/Tools/FlipClock) 198 199- [闹钟（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/CommonEventAndNotification/AlarmClock)