未验证 提交 1383b5b4 编写于 作者: O openharmony_ci 提交者: Gitee

!12213 【仅md格式规范】提醒代理文档一致性修改

Merge pull request !12213 from 廖康康/master
...@@ -392,7 +392,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). ...@@ -392,7 +392,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 | | ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 |
| ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 | | ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 |
...@@ -404,7 +404,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). ...@@ -404,7 +404,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| REMINDER_TYPE_TIMER | 0 | 表示提醒类型:倒计时。 | | REMINDER_TYPE_TIMER | 0 | 表示提醒类型:倒计时。 |
| REMINDER_TYPE_CALENDAR | 1 | 表示提醒类型:日历。 | | REMINDER_TYPE_CALENDAR | 1 | 表示提醒类型:日历。 |
...@@ -417,7 +417,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). ...@@ -417,7 +417,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| title | string | 是 | 按钮显示的标题。 | | title | string | 是 | 按钮显示的标题。 |
| type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 | | type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 |
...@@ -429,7 +429,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). ...@@ -429,7 +429,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 | | pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 |
| abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 | | abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 |
...@@ -441,7 +441,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). ...@@ -441,7 +441,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名(如果设备在使用中,则只弹出通知横幅框)。 | | pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名(如果设备在使用中,则只弹出通知横幅框)。 |
| abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名(如果设备在使用中,则只弹出通知横幅框)。 | | abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名(如果设备在使用中,则只弹出通知横幅框)。 |
...@@ -453,7 +453,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). ...@@ -453,7 +453,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| reminderType | [ReminderType](#remindertype) | 是 | 指明提醒类型。 | | reminderType | [ReminderType](#remindertype) | 是 | 指明提醒类型。 |
| actionButton | [ActionButton](#actionbutton) | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 | | actionButton | [ActionButton](#actionbutton) | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 |
...@@ -478,7 +478,7 @@ ReminderRequestCalendar extends ReminderRequest ...@@ -478,7 +478,7 @@ ReminderRequestCalendar extends ReminderRequest
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 | | dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 |
| repeatMonths | Array<number> | 否 | 指明重复提醒的月份。 | | repeatMonths | Array<number> | 否 | 指明重复提醒的月份。 |
...@@ -493,7 +493,7 @@ ReminderRequestAlarm extends ReminderRequest ...@@ -493,7 +493,7 @@ ReminderRequestAlarm extends ReminderRequest
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| hour | number | 是 | 指明提醒的目标时刻。 | | hour | number | 是 | 指明提醒的目标时刻。 |
| minute | number | 是 | 指明提醒的目标分钟。 | | minute | number | 是 | 指明提醒的目标分钟。 |
...@@ -508,7 +508,7 @@ ReminderRequestTimer extends ReminderRequest ...@@ -508,7 +508,7 @@ ReminderRequestTimer extends ReminderRequest
**系统能力**:SystemCapability.Notification.ReminderAgent **系统能力**:SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 | | triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 |
...@@ -519,7 +519,7 @@ ReminderRequestTimer extends ReminderRequest ...@@ -519,7 +519,7 @@ ReminderRequestTimer extends ReminderRequest
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| year | number | 是 | 年 | | year | number | 是 | 年 |
| month | number | 是 | 月 | | month | number | 是 | 月 |
......
...@@ -37,7 +37,7 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number& ...@@ -37,7 +37,7 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number&
以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。 以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 1700001 | Notification is not enabled. | | 1700001 | Notification is not enabled. |
| 1700002 | The number of reminders exceeds the limit. | | 1700002 | The number of reminders exceeds the limit. |
...@@ -86,7 +86,7 @@ publishReminder(reminderReq: ReminderRequest): Promise<number> ...@@ -86,7 +86,7 @@ publishReminder(reminderReq: ReminderRequest): Promise<number>
以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。 以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 1700001 | Notification is not enabled. | | 1700001 | Notification is not enabled. |
| 1700002 | The number of reminders exceeds the limit. | | 1700002 | The number of reminders exceeds the limit. |
...@@ -128,7 +128,7 @@ cancelReminder(reminderId: number, callback: AsyncCallback<void>): void ...@@ -128,7 +128,7 @@ cancelReminder(reminderId: number, callback: AsyncCallback<void>): void
以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。 以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 1700003 | The reminder does not exist. | | 1700003 | The reminder does not exist. |
| 1700004 | The bundle name does not exist. | | 1700004 | The bundle name does not exist. |
...@@ -174,7 +174,7 @@ cancelReminder(reminderId: number): Promise<void> ...@@ -174,7 +174,7 @@ cancelReminder(reminderId: number): Promise<void>
以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。 以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 1700003 | The reminder does not exist. | | 1700003 | The reminder does not exist. |
| 1700004 | The bundle name does not exist. | | 1700004 | The bundle name does not exist. |
...@@ -212,7 +212,7 @@ getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): ...@@ -212,7 +212,7 @@ getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>):
以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。 以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 1700004 | The bundle name does not exist. | | 1700004 | The bundle name does not exist. |
...@@ -272,7 +272,7 @@ getValidReminders(): Promise<Array<ReminderRequest>> ...@@ -272,7 +272,7 @@ getValidReminders(): Promise<Array<ReminderRequest>>
以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。 以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 1700004 | The bundle name does not exist. | | 1700004 | The bundle name does not exist. |
...@@ -330,7 +330,7 @@ cancelAllReminders(callback: AsyncCallback<void>): void ...@@ -330,7 +330,7 @@ cancelAllReminders(callback: AsyncCallback<void>): void
以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。 以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 1700004 | The bundle name does not exist. | | 1700004 | The bundle name does not exist. |
...@@ -369,7 +369,7 @@ cancelAllReminders(): Promise<void> ...@@ -369,7 +369,7 @@ cancelAllReminders(): Promise<void>
以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。 以下错误码的详细介绍请参见[@ohos.reminderAgentManager(后台代理提醒)](../errorcodes/errorcode-reminderAgentManager.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 1700004 | The bundle name does not exist. | | 1700004 | The bundle name does not exist. |
...@@ -541,7 +541,7 @@ try { ...@@ -541,7 +541,7 @@ try {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 | | ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 |
| ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 | | ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 |
...@@ -553,7 +553,7 @@ try { ...@@ -553,7 +553,7 @@ try {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| REMINDER_TYPE_TIMER | 0 | 表示提醒类型:倒计时。 | | REMINDER_TYPE_TIMER | 0 | 表示提醒类型:倒计时。 |
| REMINDER_TYPE_CALENDAR | 1 | 表示提醒类型:日历。 | | REMINDER_TYPE_CALENDAR | 1 | 表示提醒类型:日历。 |
...@@ -566,7 +566,7 @@ try { ...@@ -566,7 +566,7 @@ try {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| title | string | 是 | 按钮显示的标题。 | | title | string | 是 | 按钮显示的标题。 |
| type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 | | type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 |
...@@ -578,7 +578,7 @@ try { ...@@ -578,7 +578,7 @@ try {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 | | pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 |
| abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 | | abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 |
...@@ -590,7 +590,7 @@ try { ...@@ -590,7 +590,7 @@ try {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名(如果设备在使用中,则只弹出通知横幅框)。 | | pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名(如果设备在使用中,则只弹出通知横幅框)。 |
| abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名(如果设备在使用中,则只弹出通知横幅框)。 | | abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名(如果设备在使用中,则只弹出通知横幅框)。 |
...@@ -602,7 +602,7 @@ try { ...@@ -602,7 +602,7 @@ try {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| reminderType | [ReminderType](#remindertype) | 是 | 指明提醒类型。 | | reminderType | [ReminderType](#remindertype) | 是 | 指明提醒类型。 |
| actionButton | [ActionButton](#actionbutton) | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 | | actionButton | [ActionButton](#actionbutton) | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 |
...@@ -627,7 +627,7 @@ ReminderRequestCalendar extends ReminderRequest ...@@ -627,7 +627,7 @@ ReminderRequestCalendar extends ReminderRequest
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 | | dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 |
| repeatMonths | Array<number> | 否 | 指明重复提醒的月份。 | | repeatMonths | Array<number> | 否 | 指明重复提醒的月份。 |
...@@ -642,7 +642,7 @@ ReminderRequestAlarm extends ReminderRequest ...@@ -642,7 +642,7 @@ ReminderRequestAlarm extends ReminderRequest
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| hour | number | 是 | 指明提醒的目标时刻。 | | hour | number | 是 | 指明提醒的目标时刻。 |
| minute | number | 是 | 指明提醒的目标分钟。 | | minute | number | 是 | 指明提醒的目标分钟。 |
...@@ -657,7 +657,7 @@ ReminderRequestTimer extends ReminderRequest ...@@ -657,7 +657,7 @@ ReminderRequestTimer extends ReminderRequest
**系统能力**:SystemCapability.Notification.ReminderAgent **系统能力**:SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 | | triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 |
...@@ -668,7 +668,7 @@ ReminderRequestTimer extends ReminderRequest ...@@ -668,7 +668,7 @@ ReminderRequestTimer extends ReminderRequest
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| year | number | 是 | 年 | | year | number | 是 | 年 |
| month | number | 是 | 月 | | month | number | 是 | 月 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册