diff --git a/zh-cn/application-dev/background-agent-scheduled-reminder/Readme-CN.md b/zh-cn/application-dev/background-agent-scheduled-reminder/Readme-CN.md new file mode 100644 index 0000000000000000000000000000000000000000..36e13289889925f9294edc84b449172d8ec373ac --- /dev/null +++ b/zh-cn/application-dev/background-agent-scheduled-reminder/Readme-CN.md @@ -0,0 +1,4 @@ +# 后台代理提醒 + +- [概述](background-agent-scheduled-reminder-overview.md) +- [开发指导](background-agent-scheduled-reminder-guide.md) diff --git a/zh-cn/application-dev/background-agent-scheduled-reminder/background-agent-scheduled-reminder-guide.md b/zh-cn/application-dev/background-agent-scheduled-reminder/background-agent-scheduled-reminder-guide.md new file mode 100644 index 0000000000000000000000000000000000000000..cb2a6ee65b646faedb9084bc7144b45257d33155 --- /dev/null +++ b/zh-cn/application-dev/background-agent-scheduled-reminder/background-agent-scheduled-reminder-guide.md @@ -0,0 +1,267 @@ +# 开发指导 + +## 场景介绍 + +后台代理提醒主要提供后台提醒发布接口，开发者在应用开发时，可以调用这些接口去创建定时提醒，包括倒计时、日历、闹钟三种提醒类型。使用后台代理提醒能力后，应用可以被冻结或退出，计时和弹出提醒的功能将被后台系统服务代理。 + + +## 接口说明 + +reminderAgent：封装了发布、取消提醒类通知的方法 + +**表1** reminderAgent主要接口 + +| 接口名 | 描述 | +| -------- | -------- | +| function publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void;
function publishReminder(reminderReq: ReminderRequest): Promise<number>; | 发布一个定时提醒类通知。
单个应用有效的提醒个数最多支持30个（不包括已经超时，即后续不会再提醒的提醒实例）
整个系统有效的提醒个数最多支持2000个（不包括已经超时，即后续不会再提醒的提醒实例） | +| function cancelReminder(reminderId: number, callback: AsyncCallback<void>): void;
function cancelReminder(reminderId: number): Promise<void>; | 取消一个指定的提醒类通知。(reminderId从publishReminder的返回值获取) | +| function getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void;
function getValidReminders(): Promise<Array<ReminderRequest>>; | 获取当前应用设置的所有有效的提醒。 | +| function cancelAllReminders(callback: AsyncCallback<void>): void;
function cancelAllReminders(): Promise<void>; | 取消当前应用设置的所有提醒 | +| function addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void;
function addNotificationSlot(slot: NotificationSlot): Promise<void>; | 注册一个提醒类需要使用的[ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref16794355104117,link:zh-cn_topic_0000001180018813.xml#section1382174172015](zh-cn_topic_0000001180018813.xml#section1382174172015) | +| function removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void;
function removeNotificationSlot(slotType: notification.SlotType): Promise<void>; | 删除指定类型的[ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref1925235384215,link:zh-cn_topic_0000001180018813.xml#section1382174172015](zh-cn_topic_0000001180018813.xml#section1382174172015) | + +enum ActionButtonType: 在提醒弹出的通知界面上的按钮的类型。 + +**表2** ActionButtonType 枚举类型 + +| 枚举名 | 描述 | +| -------- | -------- | +| ACTION_BUTTON_TYPE_CLOSE | 指明是close按钮，点击后关闭当前提醒的铃声（如果正在响铃），关闭提醒的通知，取消延迟提醒。 | + +enum ReminderType: 提醒类型 + +**表3** ReminderType 提醒类型枚举 + +| 枚举名 | 描述 | +| -------- | -------- | +| REMINDER_TYPE_TIMER | 指明是倒计时类型 | +| REMINDER_TYPE_CALENDAR | 指明是日历类型 | +| REMINDER_TYPE_ALARM | 指明是闹钟类型 | + +interface ActionButton：在提醒弹出的通知界面上的按钮实例 + +**表4** ActionButton + +| 参数名 | 类型 | 必填 | 描述 | +| -------- | -------- | -------- | -------- | +| title | string | 是 | 按钮上显示的名称 | +| type | [ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref1265195613399,link:#table8534712161513](#table8534712161513) | 是 | 按钮的类型 | + +interface WantAgent: 设置点击通知后需要跳转的目标ability信息 + +**表5** WantAgent + +| 参数名 | 类型 | 是否必选 | 描述 | +| -------- | -------- | -------- | -------- | +| pkgName | string | 是 | 目标包的名称 | +| abilityName | string | 是 | 目标ability的名称 | + +interface MaxScreenWantAgent: 设置提醒到达时跳转的目标包。如果设备正在使用中，则弹出一个通知框 + +**表6** MaxScreenWantAgent + +| 参数名 | 类型 | 必填 | 描述 | +| -------- | -------- | -------- | -------- | +| pkgName | string | 是 | 目标包的名称 | +| abilityName | string | 是 | 目标ability的名称 | + +interface ReminderRequest: 需要发布的提醒实例的信息 + +**表7** ReminderRequest + +| 参数名 | 类型 | 必填 | 描述 | +| -------- | -------- | -------- | -------- | +| reminderType | [ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref512611316417,link:#table486010552014](#table486010552014) | 是 | 提醒的类型 | +| actionButton | [[ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref8263115334317,link:#table880311117225](#table880311117225)?, [ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref2069311554413,link:#table880311117225](#table880311117225)?] | 否 | 弹出的提醒通知栏中显示的按钮 | +| wantAgent | [ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref1577918262463,link:#table9490856350](#table9490856350) | 否 | 点击通知后需要跳转的目标ability信息 | +| maxScreenWantAgent | [ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref1069043844613,link:#table191319843714](#table191319843714) | 否 | 提醒到达时跳转的目标包。如果设备正在使用中，则弹出一个通知框 | +| ringDuration | number | 否 | 响铃时长 | +| snoozeTimes | number | 否 | 延迟提醒次数 | +| timeInterval | number | 否 | 延迟提醒间隔 | +| title | string | 否 | 提醒的标题 | +| content | string | 否 | 提醒的内容 | +| expiredContent | string | 否 | 提醒“过期”时显示的扩展内容 | +| snoozeContent | string | 否 | 提醒“再响”时显示的扩展内容 | +| notificationId | number | 否 | 提醒使用的notificationRequest的id，参见NotificationRequest.setNotificationId(int id) | +| slotType | [ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref1837619084820,link:zh-cn_topic_0000001180018813.xml#section072355105110](zh-cn_topic_0000001180018813.xml#section072355105110) | 否 | 提醒使用的slot类型 | + +interface ReminderRequestCalendar extends ReminderRequest: 日历类提醒实例。 + +第一次指定的目标时间必须大于当前时间。 + +**表8** ReminderRequestCalendar + +| 参数名 | 类型 | 必填 | 描述 | +| -------- | -------- | -------- | -------- | +| dateTime | [ERROR:Invalid link:zh-cn_topic_0000001185364575.xml#xref97387065711,link:#table16133167515](#table16133167515) | 是 | 设置目标时间 | +| repeatMonths | Array<number> | 否 | 设置重复提醒的月份 | +| repeatDays | Array<number> | 否 | 设置重复提醒的日期 | + +interface ReminderRequestAlarm extends ReminderRequest: 闹钟类提醒实例。 + +**表9** ReminderRequestAlarm + +| 参数名 | 类型 | 必填 | 描述 | +| -------- | -------- | -------- | -------- | +| hour | number | 是 | 设置目标时间（小时） | +| minute | number | 是 | 设置目标时间（分钟） | +| daysOfWeek | Array<number> | 否 | 设置每个星期哪一天重复提醒 | + +interface ReminderRequestTimer extends ReminderRequest：倒计时提醒实例 + +**表10** ReminderRequestTimer + +| 参数名 | 类型 | 必填 | 描述 | +| -------- | -------- | -------- | -------- | +| triggerTimeInSeconds | number | 是 | 设置倒计时秒数 | + +interface LocalDateTime：时间信息实例 + +**表11** LocalDateTime + +| 参数名 | 类型 | 必填 | 描述 | +| -------- | -------- | -------- | -------- | +| year | number | 是 | 年 | +| month | number | 是 | 月 | +| day | number | 是 | 日 | +| hour | number | 是 | 时 | +| minute | number | 是 | 分 | +| second | number | 否 | 秒 | + + +## 开发步骤 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 应用需要配置权限：ohos.permission.PUBLISH_AGENT_REMINDER + +发布一个10秒倒计时提醒 + +1. 定义一个倒计时实例 + ``` + import reminderAgent from '@ohos.reminderAgent'; + import notification from '@ohos.notification';export default { + timer: { + reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER, + triggerTimeInSeconds: 10, + actionButton: [ + { + title: "close", + type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE + } + ], + wantAgent: { + pkgName: "com.huawei.phone", + abilityName: "com.huawei.phone.MainAbility" + }, + maxScreenWantAgent: { + pkgName: "com.huawei.phone", + abilityName: "com.huawei.phone.MainAbility" + }, + title: "this is title", + content: "this is content", + expiredContent: "this reminder has expired", + notificationId: 100, + slotType: notification.SlotType.SOCIAL_COMMUNICATION + } + } + ``` + +2. 发布提醒 + ``` + startTimer() { + reminderAgent.publishReminder(this.timer, (err, reminderId) =>{ + this.printInfo(JSON.stringify(err)); + this.printInfo("reminderId:" + reminderId); + }); + } + ``` + + html页面： + ``` +
+ +
+ ``` + +日历实例定义： + +``` +calendar: { + reminderType: reminderAgent.ReminderType.REMINDER_TYPE_CALENDAR, + dateTime: { + year: 2050, + month: 7, + day: 30, + hour: 11, + minute: 14, + second: 30 + }, + repeatMonths: [0], + repeatDays: [0], + actionButton: [ + { + title: "close", + type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE + }, + { + title: "snooze", + type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE + }, + ], + wantAgent: { + pkgName: "com.huawei.phone", + abilityName: "com.huawei.phone.MainAbility" + }, + maxScreenWantAgent: { + pkgName: "com.huawei.phone", + abilityName: "com.huawei.phone.MainAbility" + }, + ringDuration: 5, + snoozeTimes: 2, + timeInterval: 5, + title: "this is title", + content: "this is content", + expiredContent: "this reminder has expired", + snoozeContent: "remind later", + notificationId: 100, + slotType: notification.SlotType.SOCIAL_COMMUNICATION +} +``` + +闹钟实例定义： + +``` +alarm: { + reminderType: reminderAgent.ReminderType.REMINDER_TYPE_ALARM, + hour: 11, + minute: 14, + daysOfWeek: [0], + actionButton: [ + { + title: "close", + type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE + }, + { + title: "snooze", + type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE + }, + ], + wantAgent: { + pkgName: "com.huawei.phone", + abilityName: "com.huawei.phone.MainAbility" + }, + maxScreenWantAgent: { + pkgName: "com.huawei.phone", + abilityName: "com.huawei.phone.MainAbility" + }, + ringDuration: 5, + snoozeTimes: 2, + timeInterval: 5, + title: "this is title", + content: "this is content", + expiredContent: "this reminder has expired", + snoozeContent: "remind later", + notificationId: 100, + slotType: notification.SlotType.SOCIAL_COMMUNICATION +} +``` diff --git a/zh-cn/application-dev/background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md b/zh-cn/application-dev/background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md new file mode 100644 index 0000000000000000000000000000000000000000..154feaa04e34c0dcdba3f03ee30ce4c64693c164 --- /dev/null +++ b/zh-cn/application-dev/background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md @@ -0,0 +1,3 @@ +# 概述 + +开发者在应用开发时，可以调用后台代理提醒类ReminderRequest去创建定时提醒，包括倒计时、日历、闹钟三种提醒类型。使用后台代理提醒能力后，应用可以被冻结或退出，计时和弹出提醒的功能将被后台系统服务代理。