提醒代理错误码整改

Signed-off-by: N 廖康康 <liaokangkang@huawei.com>

提醒代理错误码整改
Signed-off-by: N 廖康康 <liaokangkang@huawei.com>
4cc2dd91 · 廖康康 · 91832e5b · 4cc2dd91 · 4cc2dd91 · 4cc2dd91
4 changed file
--- a/zh-cn/application-dev/reference/apis/js-apis-reminderAgent.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-reminderAgent.md
@@ -15,11 +15,14 @@ import reminderAgent from'@ohos.reminderAgent';
 ```


-## reminderAgent.publishReminder
+## reminderAgent.publishReminder<sup>(deprecated)</sup>

 publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback&lt;number&gt;): void

 发布一个后台代理提醒，使用callback方式实现异步调用，该方法需要申请通知弹窗[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.publishReminder](js-apis-reminderAgentManager.md#reminderagentmanagerpublishreminder9)
+>
+> 从 API version 7开始支持。

 **需要权限**： ohos.permission.PUBLISH_AGENT_REMINDER

@@ -44,11 +47,14 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback&lt;number&
 ```


-## reminderAgent.publishReminder
+## reminderAgent.publishReminder<sup>(deprecated)</sup>

 publishReminder(reminderReq: ReminderRequest): Promise&lt;number&gt;

 发布一个后台代理提醒，使用Promise方式实现异步调用，该方法需要申请通知弹窗[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.publishReminder](js-apis-reminderAgentManager.md#reminderagentmanagerpublishreminder9-1)
+>
+> 从 API version 7开始支持。

 **需要权限**： ohos.permission.PUBLISH_AGENT_REMINDER

@@ -76,11 +82,14 @@ publishReminder(reminderReq: ReminderRequest): Promise&lt;number&gt;
 ```


-## reminderAgent.cancelReminder
+## reminderAgent.cancelReminder<sup>(deprecated)</sup>

 cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void

 取消指定id的提醒，使用callback方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.cancelReminder](js-apis-reminderAgentManager.md#reminderagentmanagercancelreminder9)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -100,11 +109,14 @@ reminderAgent.cancelReminder(1, (err, data) => {
 ```


-## reminderAgent.cancelReminder
+## reminderAgent.cancelReminder<sup>(deprecated)</sup>

 cancelReminder(reminderId: number): Promise&lt;void&gt;

 取消指定id的提醒，使用Promise方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.cancelReminder](js-apis-reminderAgentManager.md#reminderagentmanagercancelreminder9-1)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -129,11 +141,14 @@ reminderAgent.cancelReminder(1).then(() => {
 ```


-## reminderAgent.getValidReminders
+## reminderAgent.getValidReminders<sup>(deprecated)</sup>

 getValidReminders(callback: AsyncCallback&lt;Array&lt;ReminderRequest&gt;&gt;): void

 获取当前应用已设置的所有有效（未过期）的提醒，使用callback方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.getValidReminders](js-apis-reminderAgentManager.md#reminderagentmanagergetvalidreminders9)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -173,11 +188,14 @@ reminderAgent.getValidReminders((err, reminders) => {
 ```


-## reminderAgent.getValidReminders
+## reminderAgent.getValidReminders<sup>(deprecated)</sup>

 getValidReminders(): Promise&lt;Array&lt;ReminderRequest&gt;&gt;

 获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.getValidReminders](js-apis-reminderAgentManager.md#reminderagentmanagergetvalidreminders9-1)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -217,11 +235,14 @@ reminderAgent.getValidReminders().then((reminders) => {
 ```


-## reminderAgent.cancelAllReminders
+## reminderAgent.cancelAllReminders<sup>(deprecated)</sup>

 cancelAllReminders(callback: AsyncCallback&lt;void&gt;): void

 取消当前应用所有的提醒，使用callback方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.cancelAllReminders](js-apis-reminderAgentManager.md#reminderagentmanagercancelallreminders9)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -240,11 +261,14 @@ reminderAgent.cancelAllReminders((err, data) =>{
 ```


-## reminderAgent.cancelAllReminders
+## reminderAgent.cancelAllReminders<sup>(deprecated)</sup>

 cancelAllReminders(): Promise&lt;void&gt;

 取消当前应用所有的提醒，使用Promise方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.cancelAllReminders](js-apis-reminderAgentManager.md#reminderagentmanagercancelallreminders9-1)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -263,11 +287,14 @@ reminderAgent.cancelAllReminders().then(() => {
 ```


-## reminderAgent.addNotificationSlot
+## reminderAgent.addNotificationSlot<sup>(deprecated)</sup>

 addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback&lt;void&gt;): void

 添加一个NotificationSlot，使用callback方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.addNotificationSlot](js-apis-reminderAgentManager.md#reminderagentmanageraddnotificationslot9)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -292,11 +319,14 @@ reminderAgent.addNotificationSlot(mySlot, (err, data) => {
 ```


-## reminderAgent.addNotificationSlot
+## reminderAgent.addNotificationSlot<sup>(deprecated)</sup>

 addNotificationSlot(slot: NotificationSlot): Promise&lt;void&gt;

 添加一个NotificationSlot，使用Promise方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.addNotificationSlot](js-apis-reminderAgentManager.md#reminderagentmanageraddnotificationslot9-1)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -326,11 +356,14 @@ reminderAgent.addNotificationSlot(mySlot).then(() => {
 ```


-## reminderAgent.removeNotificationSlot
+## reminderAgent.removeNotificationSlot<sup>(deprecated)</sup>

 removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback&lt;void&gt;): void

 删除目标NotificationSlot，使用callback方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#reminderagentmanagerremovenotificationslot9)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -352,11 +385,14 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION,
 ```


-## reminderAgent.removeNotificationSlot
+## reminderAgent.removeNotificationSlot<sup>(deprecated)</sup>

 removeNotificationSlot(slotType: notification.SlotType): Promise&lt;void&gt;

 删除目标NotificationSlot，使用Promise方式实现异步调用。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#reminderagentmanagerremovenotificationslot9-1)
+>
+> 从 API version 7开始支持。

 **系统能力**： SystemCapability.Notification.ReminderAgent

@@ -383,9 +419,12 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
 ```


-## ActionButtonType
+## ActionButtonType<sup>(deprecated)</sup>

 按钮的类型。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#actionbuttontype9)
+>
+> 从 API version 7开始支持。

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

@@ -395,9 +434,12 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
 | ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 |


-## ReminderType
+## ReminderType<sup>(deprecated)</sup>

 提醒的类型。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#remindertype9)
+>
+> 从 API version 7开始支持。

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

@@ -408,9 +450,12 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
 | REMINDER_TYPE_ALARM | 2 | 表示提醒类型：闹钟。 |


-## ActionButton
+## ActionButton<sup>(deprecated)</sup>

 用于设置弹出的提醒通知信息上显示的按钮类型和标题。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#actionbutton9)
+>
+> 从 API version 7开始支持。

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

@@ -420,9 +465,12 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
 | type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 |


-## WantAgent
+## WantAgent<sup>(deprecated)</sup>

 点击提醒通知后跳转的目标ability信息。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#wantagent9)
+>
+> 从 API version 7开始支持。

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

@@ -432,9 +480,12 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
 | abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 |


-## MaxScreenWantAgent
+## MaxScreenWantAgent<sup>(deprecated)</sup>

 全屏显示提醒到达时自动拉起的目标ability信息，该接口预留。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#maxscreenwantagent9)
+>
+> 从 API version 7开始支持。

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

@@ -444,9 +495,12 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
 | abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名（如果设备在使用中，则只弹出通知横幅框）。 |


-## ReminderRequest
+## ReminderRequest<sup>(deprecated)</sup>

 提醒实例对象，用于设置提醒类型、响铃时长等具体信息。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#reminderrequest9)
+>
+> 从 API version 7开始支持。

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

@@ -467,11 +521,14 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
 | slotType | [notification.SlotType](js-apis-notification.md#slottype) | 否 | 指明提醒的slot类型。 |


-## ReminderRequestCalendar
+## ReminderRequestCalendar<sup>(deprecated)</sup>

 ReminderRequestCalendar extends ReminderRequest

 日历实例对象，用于设置提醒的时间。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#reminderrequestcalendar9)
+>
+> 从 API version 7开始支持。

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

@@ -482,11 +539,14 @@ ReminderRequestCalendar extends ReminderRequest
 | repeatDays | Array&lt;number&gt; | 否 | 指明重复提醒的日期。 |


-## ReminderRequestAlarm
+## ReminderRequestAlarm<sup>(deprecated)</sup>

 ReminderRequestAlarm extends ReminderRequest

 闹钟实例对象，用于设置提醒的时间。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#reminderrequestalarm9)
+>
+> 从 API version 7开始支持。

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

@@ -497,11 +557,14 @@ ReminderRequestAlarm extends ReminderRequest
 | daysOfWeek | Array&lt;number&gt; | 否 | 指明每周哪几天需要重复提醒。 |


-## ReminderRequestTimer
+## ReminderRequestTimer<sup>(deprecated)</sup>

 ReminderRequestTimer extends ReminderRequest

 倒计时实例对象，用于设置提醒的时间。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#reminderrequesttimer9)
+>
+> 从 API version 7开始支持。

 **系统能力**：SystemCapability.Notification.ReminderAgent

@@ -510,9 +573,12 @@ ReminderRequestTimer extends ReminderRequest
 | triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 |


-## LocalDateTime
+## LocalDateTime<sup>(deprecated)</sup>

 用于日历类提醒设置时指定时间信息。
+> **说明：** 从API version 9开始废弃，建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#localdatetime9)
+>
+> 从 API version 7开始支持。

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


--- a/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md
--- a/zh-cn/application-dev/reference/errorcodes/errcode-reminderAgentManager.md
+++ b/zh-cn/application-dev/reference/errorcodes/errcode-reminderAgentManager.md
+# reminderAgentManager错误码
+
+## 1700001 通知使能未开启
+
+### 错误信息
+Notification does not enable.
+
+### 可能原因
+1. 未申请通知使能。
+2. 通知使能被关闭。
+
+### 处理步骤
+1. 申请通知使能弹窗[Notification.requestEnableNotification](../apis/js-apis-notification.md#notificationrequestenablenotification8)。
+2. 检查通知使能是否被关闭。
+
+## 1700002 提醒数量超出限制
+
+### 错误信息
+The number of reminders exceeds the limit.
+
+### 可能原因
+1. 当前系统提醒超过2000个。
+2. 当前应用提醒超过30个。
+
+### 处理步骤
+删除不必要的提醒
+
+## 1700003 提醒不存在
+
+### 错误信息
+The reminder does not exist.
+
+### 可能原因
+1. 提醒已过期。
+2. 提醒已被删除。
+
+### 处理步骤
+1. 检查提醒是否有效。
+2. 检查提醒是否已被删除。
+
+## 1700004 包名不存在
+
+### 错误信息
+The package name does not exist.
+
+### 可能原因
+1. 包名不正确。
+2. 应用未安装。
+
+### 处理步骤
+检查应用包名是否存在。
--- a/zh-cn/application-dev/task-management/background-agent-scheduled-reminder-guide.md
+++ b/zh-cn/application-dev/task-management/background-agent-scheduled-reminder-guide.md
@@ -7,11 +7,11 @@

 ## 接口说明

-reminderAgent：封装了发布、取消提醒类通知的方法。
+reminderAgentManager：封装了发布、取消提醒类通知的方法。

 具体后台提醒相关功能接口请见[后台代理提醒](../reference/apis/js-apis-reminderAgent.md)。

-**表1** reminderAgent主要接口
+**表1** reminderAgentManager主要接口

 | 接口名 | 描述 |
 | -------- | -------- |
@@ -34,17 +34,17 @@ reminderAgent：封装了发布、取消提醒类通知的方法。

   倒计时实例定义：
   ```js
-   import reminderAgent from '@ohos.reminderAgent';
+   import reminderAgentManager from '@ohos.reminderAgentManager';
   import notification from '@ohos.notification';
   export default {
       // eTS工程：
-       let timer : reminderAgent.ReminderRequestTimer = {
-           reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
+       let timer : reminderAgentManager.ReminderRequestTimer = {
+           reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_TIMER,
           triggerTimeInSeconds: 10,
           actionButton: [
               {
                   title: "close",
-                   type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
+                   type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
               }
           ],
           wantAgent: {
@@ -68,8 +68,8 @@ reminderAgent：封装了发布、取消提醒类通知的方法。

    ```js
    // eTS工程：
-    let calendar : reminderAgent.ReminderRequestCalendar = {
-        reminderType: reminderAgent.ReminderType.REMINDER_TYPE_CALENDAR,
+    let calendar : reminderAgentManager.ReminderRequestCalendar = {
+        reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_CALENDAR,
        dateTime: {
            year: 2050,
            month: 7,
@@ -83,11 +83,11 @@ reminderAgent：封装了发布、取消提醒类通知的方法。
        actionButton: [
            {
                title: "close",
-                type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
+                type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
            },
            {
                title: "snooze",
-                type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE
+                type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE
            },
        ],
        wantAgent: {
@@ -114,19 +114,19 @@ reminderAgent：封装了发布、取消提醒类通知的方法。

    ```js
    // eTS工程：
-    let alarm : reminderAgent.ReminderRequestAlarm = {
-        reminderType: reminderAgent.ReminderType.REMINDER_TYPE_ALARM,
+    let alarm : reminderAgentManager.ReminderRequestAlarm = {
+        reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_ALARM,
        hour: 11,
        minute: 14,
        daysOfWeek: [0],
        actionButton: [
            {
                title: "close",
-                type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
+                type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
            },
            {
                title: "snooze",
-                type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE
+                type: reminderAgentManager.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE
            },
        ],
        wantAgent: {
@@ -152,10 +152,15 @@ reminderAgent：封装了发布、取消提醒类通知的方法。
 2. 发布倒计时提醒。
   ```js
   startTimer() {
-       reminderAgent.publishReminder(this.timer, (err, reminderId) =>{
-           this.printInfo(JSON.stringify(err));
-           this.printInfo("reminderId:" + reminderId);
-       });
+        try {
+            reminderAgent.publishReminder(this.timer).then(res => {
+                console.log("publishReminder promise reminderId:" + res);
+            }).catch(err => {
+                console.log("publishReminder err code:" + err.code + " message:" + err.message);
+            })
+        } catch (error) {
+            console.log("publishReminder code:" + error.code + " message:" + error.message);
+        };
   }
   ```