后台代理提醒
说明: 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import reminderAgent from'@ohos.reminderAgent';
reminderAgent.publishReminder
publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void
发布一个后台代理提醒,使用callback方式实现异步调用。
需要权限: ohos.permission.PUBLISH_AGENT_REMINDER
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
reminderReq | ReminderRequest | 是 | 需要发布的提醒实例。 |
callback | AsyncCallback<number> | 是 | 异步回调,返回当前发布的提醒的reminderId。 |
示例:
export default {
data: {
timer: {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 3
}
},
startTimer() {
reminderAgent.publishReminder(timer, (err, reminderId) => { console.log("reminderId = " + reminderId);
});
}
}
reminderAgent.publishReminder
publishReminder(reminderReq: ReminderRequest): Promise<number>
发布一个后台代理提醒,使用Promise方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
reminderReq | ReminderRequest | 是 | 需要发布的提醒实例。 |
返回值:
类型 | 说明 |
---|---|
Promise<number> | 返回提醒的reminderId。 |
示例:
export default {
data:
{timer: {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 3
}
},
startTimer() {
reminderAgent.publishReminder(this.timer).then((reminderId) => {
console.log("reminderId = " + reminderId);
});
}
}
reminderAgent.cancelReminder
cancelReminder(reminderId: number, callback: AsyncCallback<void>): void
取消指定id的提醒,使用callback方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
reminderId | number | 是 | 目标reminder的id号。 |
callback | AsyncCallback<void> | 是 | 异步回调。 |
示例:
export default {
cancel() {
reminderAgent.cancelReminder(1, (err, data) => {
console.log("do next");
});
}
}
reminderAgent.cancelReminder
cancelReminder(reminderId: number): Promise<void>
取消指定id的提醒,使用Promise方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
reminderId | number | 是 | 目标reminder的id号。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise类型异步回调。 |
示例:
export default {
cancel() {
reminderAgent.cancelReminder(1).then(() => {
console.log("do next");
});
}
}
reminderAgent.getValidReminders
getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void
获取当前应用已设置的所有有效(未过期)的提醒,使用callback方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<Array<ReminderRequest>> | 是 | 异步回调,返回当前应用已设置的所有有效(未过期)的提醒。 |
示例:
reminderAgent.getValidReminders((err, reminders) => {
for (let i = 0; i < reminders.length; i++) {
console.log("getValidReminders = " + reminders[i]);
console.log("getValidReminders, reminderType = " + reminders[i].reminderType);
for (let j = 0; j < reminders[i].actionButton.length; j++) {
console.log("getValidReminders, actionButton.title = " + reminders[i].actionButton[j].title);
console.log("getValidReminders, actionButton.type = " + reminders[i].actionButton[j].type);
}
console.log("getValidReminders, wantAgent.pkgName = " + reminders[i].wantAgent.pkgName);
console.log("getValidReminders, wantAgent.abilityName = " + reminders[i].wantAgent.abilityName);
console.log("getValidReminders, maxScreenWantAgent.pkgName = " + reminders[i].maxScreenWantAgent.pkgName);
console.log("getValidReminders, maxScreenWantAgent.abilityName = " + reminders[i].maxScreenWantAgent.abilityName);
console.log("getValidReminders, ringDuration = " + reminders[i].ringDuration);
console.log("getValidReminders, snoozeTimes = " + reminders[i].snoozeTimes);
console.log("getValidReminders, timeInterval = " + reminders[i].timeInterval);
console.log("getValidReminders, title = " + reminders[i].title);
console.log("getValidReminders, content = " + reminders[i].content);
console.log("getValidReminders, expiredContent = " + reminders[i].expiredContent);
console.log("getValidReminders, snoozeContent = " + reminders[i].snoozeContent);
console.log("getValidReminders, notificationId = " + reminders[i].notificationId);
console.log("getValidReminders, slotType = " + reminders[i].slotType);
}
})
reminderAgent.getValidReminders
getValidReminders(): Promise<Array<ReminderRequest>>
获取当前应用已设置的所有有效(未过期)的提醒,使用Promise方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
返回值:
类型 | 说明 |
---|---|
Promise<Array<ReminderRequest>> | 返回当前应用已设置的所有有效(未过期)的提醒。 |
示例:
reminderAgent.getValidReminders().then((reminders) => {
for (let i = 0; i < reminders.length; i++) {
console.log("getValidReminders = " + reminders[i]);
console.log("getValidReminders, reminderType = " + reminders[i].reminderType);
for (let j = 0; j < reminders[i].actionButton.length; j++) {
console.log("getValidReminders, actionButton.title = " + reminders[i].actionButton[j].title);
console.log("getValidReminders, actionButton.type = " + reminders[i].actionButton[j].type);
}
console.log("getValidReminders, wantAgent.pkgName = " + reminders[i].wantAgent.pkgName);
console.log("getValidReminders, wantAgent.abilityName = " + reminders[i].wantAgent.abilityName);
console.log("getValidReminders, maxScreenWantAgent.pkgName = " + reminders[i].maxScreenWantAgent.pkgName);
console.log("getValidReminders, maxScreenWantAgent.abilityName = " + reminders[i].maxScreenWantAgent.abilityName);
console.log("getValidReminders, ringDuration = " + reminders[i].ringDuration);
console.log("getValidReminders, snoozeTimes = " + reminders[i].snoozeTimes);
console.log("getValidReminders, timeInterval = " + reminders[i].timeInterval);
console.log("getValidReminders, title = " + reminders[i].title);
console.log("getValidReminders, content = " + reminders[i].content);
console.log("getValidReminders, expiredContent = " + reminders[i].expiredContent);
console.log("getValidReminders, snoozeContent = " + reminders[i].snoozeContent);
console.log("getValidReminders, notificationId = " + reminders[i].notificationId);
console.log("getValidReminders, slotType = " + reminders[i].slotType);
}
})
reminderAgent.cancelAllReminders
cancelAllReminders(callback: AsyncCallback<void>): void
取消当前应用所有的提醒,使用callback方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 异步回调。 |
示例:
reminderAgent.cancelAllReminders((err, data) =>{
console.log("do next")})
reminderAgent.cancelAllReminders
cancelAllReminders(): Promise<void>
取消当前应用所有的提醒,使用Promise方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise类型异步回调。 |
示例:
reminderAgent.cancelAllReminders().then(() => {
console.log("do next")})
reminderAgent.addNotificationSlot
addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void
添加一个NotificationSlot,使用callback方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
slot | NotificationSlot | 是 | notification slot实例。 |
callback | AsyncCallback<void> | 是 | 异步回调。 |
示例:
export default { data: { mySlot: {
type: 3,
sound: "/sdcard/music2.mp3"
} },
addSlot() {
reminderAgent.addNotificationSlot(this.mySlot, (err, data) => {
console.log("do next");
});
}
}
reminderAgent.addNotificationSlot
addNotificationSlot(slot: NotificationSlot): Promise<void>
添加一个NotificationSlot,使用Promise方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
slot | NotificationSlot | 是 | notification slot实例。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise类型异步回调。 |
示例:
export default { data: { mySlot: {
type: 3,
sound: "/sdcard/music2.mp3"
} },
addSlot() {
reminderAgent.addNotificationSlot(this.mySlot).then(() => {
console.log("do next");
});
}
}
reminderAgent.removeNotificationSlot
removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void
删除目标NotificationSlot,使用callback方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
slotType | notification.SlotType | 是 | 目标notification slot的类型。 |
callback | AsyncCallback<void> | 是 | 异步回调。 |
示例:
export default {
removeSlot() {reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) => {
console.log("do next");
});
}
}
reminderAgent.removeNotificationSlot
removeNotificationSlot(slotType: notification.SlotType): Promise<void>
删除目标NotificationSlot,使用Promise方式实现异步调用。
系统能力: SystemCapability.Notification.ReminderAgent
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
slotType | notification.SlotType | 是 | 目标notification slot的类型。 |
返回值:
类型 | 说明 |
---|---|
Promise<void> | Promise类型异步回调。 |
示例:
export default {
removeSlot() { reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() => {
console.log("do next");
});
}
}
ActionButtonType
按钮的类型。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 默认值 | 说明 |
---|---|---|
ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 |
ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 |
ReminderType
提醒的类型。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 默认值 | 说明 |
---|---|---|
REMINDER_TYPE_TIMER | 0 | 表示提醒类型:倒计时。 |
REMINDER_TYPE_CALENDAR | 1 | 表示提醒类型:日历。 |
REMINDER_TYPE_ALARM | 2 | 表示提醒类型:闹钟。 |
ActionButton
用于设置弹出的提醒通知信息上显示的按钮类型和标题。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
title | string | 是 | 按钮显示的标题。 |
type | ActionButtonType | 是 | 按钮的类型。 |
WantAgent
点击提醒通知后跳转的目标ability信息。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 |
abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 |
MaxScreenWantAgent
提醒到达时自动拉起的目标ability信息。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名(如果设备在使用中,则只弹出通知横幅框)。 |
abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名(如果设备在使用中,则只弹出通知横幅框)。 |
ReminderRequest
提醒实例对象,用于设置提醒类型、响铃时长等具体信息。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
reminderType | ReminderType | 是 | 指明提醒类型。 |
actionButton | [ActionButton?, ActionButton?] | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 |
wantAgent | WantAgent | 否 | 点击通知后需要跳转的目标ability信息。 |
maxScreenWantAgent | MaxScreenWantAgent | 否 | 提醒到达时跳转的目标包。如果设备正在使用中,则弹出一个通知框。 |
ringDuration | number | 否 | 指明响铃时长。 |
snoozeTimes | number | 否 | 指明延迟提醒次数。 |
timeInterval | number | 否 | 执行延迟提醒间隔。 |
title | string | 否 | 指明提醒标题。 |
content | string | 否 | 指明提醒内容。 |
expiredContent | string | 否 | 指明提醒过期后需要显示的内容。 |
snoozeContent | string | 否 | 指明延迟提醒时需要显示的内容。 |
notificationId | number | 否 | 指明提醒使用的通知的id号,相同id号的提醒会覆盖。 |
slotType | notification.SlotType | 否 | 指明提醒的slot类型。 |
ReminderRequestCalendar
ReminderRequestCalendar extends ReminderRequest
日历实例对象,用于设置提醒的时间。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
dateTime | LocalDateTime | 是 | 指明提醒的目标时间。 |
repeatMonths | Array<number> | 否 | 指明重复提醒的月份。 |
repeatDays | Array<number> | 否 | 指明重复提醒的日期。 |
ReminderRequestAlarm
ReminderRequestAlarm extends ReminderRequest
闹钟实例对象,用于设置提醒的时间。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
hour | number | 是 | 指明提醒的目标时刻。 |
minute | number | 是 | 指明提醒的目标分钟。 |
daysOfWeek | Array<number> | 否 | 指明每周哪几天需要重复提醒。 |
ReminderRequestTimer
ReminderRequestTimer extends ReminderRequest
倒计时实例对象,用于设置提醒的时间。
系统能力:SystemCapability.Notification.ReminderAgent
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 |
LocalDateTime
用于日历类提醒设置时指定时间信息。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
名称 | 参数类型 | 必填 | 说明 |
---|---|---|---|
year | number | 是 | 年 |
month | number | 是 | 月 |
day | number | 是 | 日 |
hour | number | 是 | 时 |
minute | number | 是 | 分 |
second | number | 否 | 秒 |