后台提醒开发指导

场景介绍

后台代理提醒主要提供后台提醒发布接口，开发者在应用开发时，可以调用这些接口去创建定时提醒，包括倒计时、日历、闹钟三种提醒类型。使用后台代理提醒能力后，应用可以被冻结或退出，计时和弹出提醒的功能将被后台系统服务代理。

接口说明

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

具体后台提醒相关功能接口请见后台代理提醒。

表1 reminderAgent主要接口

接口名	描述
publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void publishReminder(reminderReq: ReminderRequest): Promise<number>	发布一个定时提醒类通知。单个应用有效的提醒个数最多支持30个（不包括已经超时，即后续不会再提醒的提醒实例）整个系统有效的提醒个数最多支持2000个（不包括已经超时，即后续不会再提醒的提醒实例）
cancelReminder(reminderId: number, callback: AsyncCallback<void>): void cancelReminder(reminderId: number): Promise<void>	取消一个指定的提醒类通知。(reminderId从publishReminder的返回值获取)
getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void getValidReminders(): Promise<Array<ReminderRequest>>	获取当前应用设置的所有有效的提醒。
cancelAllReminders(callback: AsyncCallback<void>): void cancelAllReminders(): Promise<void>	取消当前应用设置的所有提醒
addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void addNotificationSlot(slot: NotificationSlot): Promise<void>	注册一个提醒类需要使用的NotificationSlot
removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void removeNotificationSlot(slotType: notification.SlotType): Promise<void>	删除指定类型的NotificationSlot

开发步骤

说明：

应用需要配置权限：ohos.permission.PUBLISH_AGENT_REMINDER。

应用需要申请通知弹窗：Notification.requestEnableNotification。

定义一个提醒代理。

倒计时实例定义：

import reminderAgent from '@ohos.reminderAgent';
import notification from '@ohos.notification';
export default {
    // JS工程写法：
    // timer: {
    // eTS工程写法：
    let timer : reminderAgent.ReminderRequestTimer = {
        reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
        triggerTimeInSeconds: 10,
        actionButton: [
            {
                title: "close",
                type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
            }
        ],
        wantAgent: {
            pkgName: "com.example.device",
            abilityName: "com.example.device.MainAbility"
        },
        maxScreenWantAgent: {
            pkgName: "com.example.device",
            abilityName: "com.example.device.MainAbility"
        },
        title: "this is title",
        content: "this is content",
        expiredContent: "this reminder has expired",
        notificationId: 100,
        slotType: notification.SlotType.SOCIAL_COMMUNICATION
    }
}

日历实例定义：

// JS工程写法：
// calendar: {
// eTS工程写法：
let calendar : reminderAgent.ReminderRequestCalendar = {
    reminderType: reminderAgent.ReminderType.REMINDER_TYPE_CALENDAR,
    dateTime: {
        year: 2050,
        month: 7,
        day: 30,
        hour: 11,
        minute: 14,
        second: 30
    },
    repeatMonths: [1],
    repeatDays: [1],
    actionButton: [
        {
            title: "close",
            type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_CLOSE
        },
        {
            title: "snooze",
            type: reminderAgent.ActionButtonType.ACTION_BUTTON_TYPE_SNOOZE
        },
    ],
    wantAgent: {
        pkgName: "com.example.device",
        abilityName: "com.example.device.MainAbility"
    },
    maxScreenWantAgent: {
        pkgName: "com.example.device",
        abilityName: "com.example.device.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
}

闹钟实例定义：

// JS工程写法：
// alarm: {
// eTS工程写法：
let alarm : reminderAgent.ReminderRequestAlarm = {
    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.example.device",
        abilityName: "com.example.device.MainAbility"
    },
    maxScreenWantAgent: {
        pkgName: "com.example.device",
        abilityName: "com.example.device.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
}

发布倒计时提醒。

startTimer() {
    reminderAgent.publishReminder(this.timer, (err, reminderId) =>{
        this.printInfo(JSON.stringify(err));
        this.printInfo("reminderId:" + reminderId);
    });
}

HML页面：

<div class="container">
    <button type="text" value="publishReminder" onclick="startTimer"></button>
</div>

后台提醒开发指导

场景介绍

接口说明

开发步骤

相关实例