update reminder api

Signed-off-by: gaojiaqi <gaojiaqi7@huawei.com>
This commit is contained in:
gaojiaqi 2024-07-08 19:05:09 +08:00
parent 80af2c5350
commit 6f85cca41a
2 changed files with 72 additions and 72 deletions

View File

@ -254,20 +254,20 @@ declare namespace reminderAgent {
interface ActionButton {
/**
* Text on the button.
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { string }
* @useinstead reminderAgentManager.ActionButton.title
*/
title: string;
/**
* Button type.
* @type { ActionButtonType }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ActionButtonType }
* @useinstead reminderAgentManager.ActionButton.type
*/
type: ActionButtonType;
@ -286,20 +286,20 @@ declare namespace reminderAgent {
interface WantAgent {
/**
* Name of the package redirected to when the reminder notification is clicked.
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { string }
* @useinstead reminderAgentManager.WantAgent.pkgName
*/
pkgName: string;
/**
* Name of the ability that is redirected to when the reminder notification is clicked.
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { string }
* @useinstead reminderAgentManager.WantAgent.abilityName
*/
abilityName: string;
@ -317,20 +317,20 @@ declare namespace reminderAgent {
interface MaxScreenWantAgent {
/**
* Name of the package that is automatically started when the reminder arrives and the device is not in use.
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { string }
* @useinstead reminderAgentManager.MaxScreenWantAgent.pkgName
*/
pkgName: string;
/**
* Name of the ability that is automatically started when the reminder arrives and the device is not in use.
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { string }
* @useinstead reminderAgentManager.MaxScreenWantAgent.abilityName
*/
abilityName: string;
@ -348,10 +348,10 @@ declare namespace reminderAgent {
interface ReminderRequest {
/**
* Type of the reminder.
* @type { ReminderType }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ReminderType }
* @useinstead reminderAgentManager.ReminderRequest.reminderType
*/
reminderType: ReminderType;
@ -359,20 +359,20 @@ declare namespace reminderAgent {
/**
* Action button displayed on the reminder notification.
* (The parameter is optional. Up to two buttons are supported).
* @type { ?[ActionButton?, ActionButton?] }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?[ActionButton?, ActionButton?] }
* @useinstead reminderAgentManager.ReminderRequest.actionButton
*/
actionButton?: [ActionButton?, ActionButton?];
/**
* Information about the ability that is redirected to when the notification is clicked.
* @type { ?WantAgent }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?WantAgent }
* @useinstead reminderAgentManager.ReminderRequest.wantAgent
*/
wantAgent?: WantAgent;
@ -380,100 +380,100 @@ declare namespace reminderAgent {
/**
* Information about the ability that is automatically started when the reminder arrives.
* If the device is in use, a notification will be displayed.
* @type { ?MaxScreenWantAgent }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?MaxScreenWantAgent }
* @useinstead reminderAgentManager.ReminderRequest.maxScreenWantAgent
*/
maxScreenWantAgent?: MaxScreenWantAgent;
/**
* Ringing duration.
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?number }
* @useinstead reminderAgentManager.ReminderRequest.ringDuration
*/
ringDuration?: number;
/**
* Number of reminder snooze times.
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?number }
* @useinstead reminderAgentManager.ReminderRequest.snoozeTimes
*/
snoozeTimes?: number;
/**
* Reminder snooze interval.
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?number }
* @useinstead reminderAgentManager.ReminderRequest.timeInterval
*/
timeInterval?: number;
/**
* Reminder title.
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?string }
* @useinstead reminderAgentManager.ReminderRequest.title
*/
title?: string;
/**
* Reminder content.
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?string }
* @useinstead reminderAgentManager.ReminderRequest.content
*/
content?: string;
/**
* Content to be displayed when the reminder is expired.
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?string }
* @useinstead reminderAgentManager.ReminderRequest.expiredContent
*/
expiredContent?: string;
/**
* Content to be displayed when the reminder is snoozing.
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?string }
* @useinstead reminderAgentManager.ReminderRequest.snoozeContent
*/
snoozeContent?: string;
/**
* notification id. If there are reminders with the same ID, the later one will overwrite the earlier one.
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?number }
* @useinstead reminderAgentManager.ReminderRequest.notificationId
*/
notificationId?: number;
/**
* Type of the slot used by the reminder.
* @type { ?notification.SlotType }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?notification.SlotType }
* @useinstead reminderAgentManager.ReminderRequest.slotType
*/
slotType?: notification.SlotType;
@ -489,30 +489,30 @@ declare namespace reminderAgent {
interface ReminderRequestCalendar extends ReminderRequest {
/**
* Reminder time.
* @type { LocalDateTime }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { LocalDateTime }
* @useinstead reminderAgentManager.ReminderRequestCalendar.dateTime
*/
dateTime: LocalDateTime;
/**
* Month in which the reminder repeats.
* @type { ?Array<number> }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?Array<number> }
* @useinstead reminderAgentManager.ReminderRequestCalendar.repeatMonths
*/
repeatMonths?: Array<number>;
/**
* Date on which the reminder repeats.
* @type { ?Array<number> }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?Array<number> }
* @useinstead reminderAgentManager.ReminderRequestCalendar.repeatDays
*/
repeatDays?: Array<number>;
@ -530,30 +530,30 @@ declare namespace reminderAgent {
interface ReminderRequestAlarm extends ReminderRequest {
/**
* Hour portion of the reminder time.
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { number }
* @useinstead reminderAgentManager.ReminderRequestAlarm.hour
*/
hour: number;
/**
* minute portion of the remidner time.
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { number }
* @useinstead reminderAgentManager.ReminderRequestAlarm.minute
*/
minute: number;
/**
* Days of a week when the reminder repeates.
* @type { ?Array<number> }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?Array<number> }
* @useinstead reminderAgentManager.ReminderRequestAlarm.daysOfWeek
*/
daysOfWeek?: Array<number>;
@ -571,10 +571,10 @@ declare namespace reminderAgent {
interface ReminderRequestTimer extends ReminderRequest {
/**
* value of triggerTimeInSeconds.
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { number }
* @useinstead reminderAgentManager.ReminderRequestTimer.triggerTimeInSeconds
*/
triggerTimeInSeconds: number;
@ -592,60 +592,60 @@ declare namespace reminderAgent {
interface LocalDateTime {
/**
* value of year.
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { number }
* @useinstead reminderAgentManager.ReminderRequestTimer.year
*/
year: number;
/**
* value of month.
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { number }
* @useinstead reminderAgentManager.ReminderRequestTimer.month
*/
month: number;
/**
* value of day.
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { number }
* @useinstead reminderAgentManager.ReminderRequestTimer.day
*/
day: number;
/**
* value of hour.
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { number }
* @useinstead reminderAgentManager.ReminderRequestTimer.hour
*/
hour: number;
/**
* value of minute.
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { number }
* @useinstead reminderAgentManager.ReminderRequestTimer.minute
*/
minute: number;
/**
* value of second.
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 7
* @deprecated since 9
* @type { ?number }
* @useinstead reminderAgentManager.ReminderRequestTimer.second
*/
second?: number;

View File

@ -302,8 +302,8 @@ declare namespace reminderAgentManager {
/**
* Text on the button.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
title: string;
@ -320,8 +320,8 @@ declare namespace reminderAgentManager {
/**
* Button type.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ActionButtonType }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
type: ActionButtonType;
@ -329,9 +329,9 @@ declare namespace reminderAgentManager {
/**
* Information about the ability that is redirected to when the button is clicked.
*
* @type { ?WantAgent }
* @syscap SystemCapability.Notification.ReminderAgent
* @systemapi Hide this for inner system use.
* @type { ?WantAgent }
* @since 10
*/
wantAgent?: WantAgent;
@ -359,8 +359,8 @@ declare namespace reminderAgentManager {
/**
* Name of the package redirected to when the reminder notification is clicked.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
pkgName: string;
@ -368,8 +368,8 @@ declare namespace reminderAgentManager {
/**
* Name of the ability that is redirected to when the reminder notification is clicked.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
abilityName: string;
@ -377,8 +377,8 @@ declare namespace reminderAgentManager {
/**
* The Uniform Resource Identifier (URI) that will be redirected to.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 12
*/
uri?: string;
@ -386,8 +386,8 @@ declare namespace reminderAgentManager {
/**
* The description of the WantParams object in an Want
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?Record<string, Object> }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 12
*/
parameters?: Record<string, Object>;
@ -445,8 +445,8 @@ declare namespace reminderAgentManager {
/**
* Name of the package that is automatically started when the reminder arrives and the device is not in use.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
pkgName: string;
@ -454,8 +454,8 @@ declare namespace reminderAgentManager {
/**
* Name of the ability that is automatically started when the reminder arrives and the device is not in use.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
abilityName: string;
@ -472,8 +472,8 @@ declare namespace reminderAgentManager {
/**
* Type of the reminder.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ReminderType }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
reminderType: ReminderType;
@ -489,8 +489,8 @@ declare namespace reminderAgentManager {
* Action button displayed on the reminder notification.
* (The parameter is optional. Up to three buttons are supported).
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?[ActionButton?, ActionButton?, ActionButton?] }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 10
*/
actionButton?: [ActionButton?, ActionButton?, ActionButton?];
@ -498,8 +498,8 @@ declare namespace reminderAgentManager {
/**
* Information about the ability that is redirected to when the notification is clicked.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?WantAgent }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
wantAgent?: WantAgent;
@ -516,8 +516,8 @@ declare namespace reminderAgentManager {
/**
* Ringing duration.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
ringDuration?: number;
@ -525,8 +525,8 @@ declare namespace reminderAgentManager {
/**
* Number of reminder snooze times.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
snoozeTimes?: number;
@ -534,8 +534,8 @@ declare namespace reminderAgentManager {
/**
* Reminder snooze interval.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
timeInterval?: number;
@ -543,8 +543,8 @@ declare namespace reminderAgentManager {
/**
* Reminder title.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
title?: string;
@ -552,8 +552,8 @@ declare namespace reminderAgentManager {
/**
* Reminder content.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
content?: string;
@ -561,8 +561,8 @@ declare namespace reminderAgentManager {
/**
* Content to be displayed when the reminder is expired.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
expiredContent?: string;
@ -570,8 +570,8 @@ declare namespace reminderAgentManager {
/**
* Content to be displayed when the reminder is snoozing.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?string }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
snoozeContent?: string;
@ -579,8 +579,8 @@ declare namespace reminderAgentManager {
/**
* Notification id. If there are reminders with the same ID, the later one will overwrite the earlier one.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
notificationId?: number;
@ -597,8 +597,8 @@ declare namespace reminderAgentManager {
/**
* Type of the slot used by the reminder.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?notification.SlotType }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
slotType?: notification.SlotType;
@ -606,8 +606,8 @@ declare namespace reminderAgentManager {
/**
* Whether the notification is automatically cleared.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?boolean }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 10
*/
tapDismissed?: boolean;
@ -615,8 +615,8 @@ declare namespace reminderAgentManager {
/**
* Time when the notification is automatically cleared.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 10
*/
autoDeletedTime?: number;
@ -651,8 +651,8 @@ declare namespace reminderAgentManager {
/**
* Reminder time.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { LocalDateTime }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
dateTime: LocalDateTime;
@ -660,8 +660,8 @@ declare namespace reminderAgentManager {
/**
* Month in which the reminder repeats.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?Array<number> }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
repeatMonths?: Array<number>;
@ -669,8 +669,8 @@ declare namespace reminderAgentManager {
/**
* Date on which the reminder repeats.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?Array<number> }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
repeatDays?: Array<number>;
@ -687,8 +687,8 @@ declare namespace reminderAgentManager {
/**
* calendar end date time
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?LocalDateTime }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 12
*/
endDateTime?: LocalDateTime;
@ -697,9 +697,9 @@ declare namespace reminderAgentManager {
* For custom repeat calendar(RRule), the service extension will pull up when
* param set and the notification arrived.
*
* @type { ?WantAgent }
* @syscap SystemCapability.Notification.ReminderAgent
* @systemapi Hide this for inner system use.
* @type { ?WantAgent }
* @since 12
*/
rruleWantAgent?: WantAgent;
@ -716,8 +716,8 @@ declare namespace reminderAgentManager {
/**
* Hour portion of the reminder time.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
hour: number;
@ -725,8 +725,8 @@ declare namespace reminderAgentManager {
/**
* Minute portion of the reminder time.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
minute: number;
@ -734,8 +734,8 @@ declare namespace reminderAgentManager {
/**
* Days of a week when the reminder repeats.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?Array<number> }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
daysOfWeek?: Array<number>;
@ -753,8 +753,8 @@ declare namespace reminderAgentManager {
/**
* The number of seconds to count down.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
triggerTimeInSeconds: number;
@ -771,8 +771,8 @@ declare namespace reminderAgentManager {
/**
* reminder id.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 12
*/
reminderId: number;
@ -780,8 +780,8 @@ declare namespace reminderAgentManager {
/**
* reminder request.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ReminderRequest }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 12
*/
reminderReq: ReminderRequest;
@ -798,8 +798,8 @@ declare namespace reminderAgentManager {
/**
* Value of year.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
year: number;
@ -807,8 +807,8 @@ declare namespace reminderAgentManager {
/**
* Value of month.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
month: number;
@ -816,8 +816,8 @@ declare namespace reminderAgentManager {
/**
* Value of day.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
day: number;
@ -825,8 +825,8 @@ declare namespace reminderAgentManager {
/**
* Value of hour.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
hour: number;
@ -834,8 +834,8 @@ declare namespace reminderAgentManager {
/**
* Value of minute.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
minute: number;
@ -843,8 +843,8 @@ declare namespace reminderAgentManager {
/**
* Value of second.
*
* @syscap SystemCapability.Notification.ReminderAgent
* @type { ?number }
* @syscap SystemCapability.Notification.ReminderAgent
* @since 9
*/
second?: number;