后臺(tái)代理提醒

本模塊提供后臺(tái)代理提醒的能力。

開發(fā)應(yīng)用時(shí)，開發(fā)者可以調(diào)用后臺(tái)提醒發(fā)布的接口創(chuàng)建定時(shí)提醒，包括倒計(jì)時(shí)、日歷、鬧鐘三種提醒類型。使用后臺(tái)代理提醒能力后，應(yīng)用可以被凍結(jié)或退出，計(jì)時(shí)和彈出提醒的功能將被后臺(tái)系統(tǒng)服務(wù)代理。
說明： 本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

導(dǎo)入模塊

import reminderAgent from'@ohos.reminderAgent';

開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]點(diǎn)擊或者復(fù)制轉(zhuǎn)到。

reminderAgent.publishReminder

publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback): void

發(fā)布一個(gè)后臺(tái)代理提醒，使用callback方式實(shí)現(xiàn)異步調(diào)用。

需要權(quán)限 ： ohos.permission.PUBLISH_AGENT_REMINDER

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

示例 ：

let timer = {
      reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
      triggerTimeInSeconds: 10
  }
  reminderAgent.publishReminder(timer, (err, reminderId) = > {
      console.log("callback, reminderId = " + reminderId);
  });

reminderAgent.publishReminder

publishReminder(reminderReq: ReminderRequest): Promise

發(fā)布一個(gè)后臺(tái)代理提醒，使用Promise方式實(shí)現(xiàn)異步調(diào)用。

需要權(quán)限 ： ohos.permission.PUBLISH_AGENT_REMINDER

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

返回值 ：

示例 ：

let timer = {
      reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
      triggerTimeInSeconds: 10
  }
  reminderAgent.publishReminder(timer).then((reminderId) = > {
      console.log("promise, reminderId = " + reminderId);
  });

reminderAgent.cancelReminder

cancelReminder(reminderId: number, callback: AsyncCallback): void

取消指定id的提醒，使用callback方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

示例 ：

reminderAgent.cancelReminder(1, (err, data) = > {
    console.log("cancelReminder callback");
});

reminderAgent.cancelReminder

cancelReminder(reminderId: number): Promise

取消指定id的提醒，使用Promise方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

返回值 ：

示例 ：

reminderAgent.cancelReminder(1).then(() = > {
    console.log("cancelReminder promise");
});

reminderAgent.getValidReminders

getValidReminders(callback: AsyncCallback>): void

獲取當(dāng)前應(yīng)用已設(shè)置的所有有效（未過期）的提醒，使用callback方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

示例 ：

reminderAgent.getValidReminders((err, reminders) = > {
    console.log("callback, getValidReminders length = " + reminders.length);
    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>

獲取當(dāng)前應(yīng)用已設(shè)置的所有有效（未過期）的提醒，使用Promise方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

返回值 ：

示例 ：

reminderAgent.getValidReminders().then((reminders) = > {
    console.log("promise, getValidReminders length = " + reminders.length);
    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

取消當(dāng)前應(yīng)用所有的提醒，使用callback方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

示例 ：

reminderAgent.cancelAllReminders((err, data) = >{
    console.log("cancelAllReminders callback")
})

reminderAgent.cancelAllReminders

cancelAllReminders(): Promise

取消當(dāng)前應(yīng)用所有的提醒，使用Promise方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

返回值 ：

示例 ：

reminderAgent.cancelAllReminders().then(() = > {
    console.log("cancelAllReminders promise")
})

reminderAgent.addNotificationSlot

addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback): void

添加一個(gè)NotificationSlot，使用callback方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

示例 ：

import notification from '@ohos.notification'

let mySlot = {
    type: notification.SlotType.SOCIAL_COMMUNICATION
}
reminderAgent.addNotificationSlot(mySlot, (err, data) = > {
    console.log("addNotificationSlot callback");
});

reminderAgent.addNotificationSlot

addNotificationSlot(slot: NotificationSlot): Promise

添加一個(gè)NotificationSlot，使用Promise方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

返回值 ：

示例 ：

import notification from '@ohos.notification'

let mySlot = {
    type: notification.SlotType.SOCIAL_COMMUNICATION
}
reminderAgent.addNotificationSlot(mySlot).then(() = > {
   console.log("addNotificationSlot promise");
});

reminderAgent.removeNotificationSlot

removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback): void

刪除目標(biāo)NotificationSlot，使用callback方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

示例 ：

import notification from '@ohos.notification'

reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) = > {
    console.log("removeNotificationSlot callback");
});

reminderAgent.removeNotificationSlot

removeNotificationSlot(slotType: notification.SlotType): Promise

刪除目標(biāo)NotificationSlot，使用Promise方式實(shí)現(xiàn)異步調(diào)用。

系統(tǒng)能力 ： SystemCapability.Notification.ReminderAgent

參數(shù) ：

返回值 ：

示例 ：

import notification from '@ohos.notification'

reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() = > {
    console.log("removeNotificationSlot promise");
});

ActionButtonType

按鈕的類型。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent

ReminderType

提醒的類型。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent

ActionButton

用于設(shè)置彈出的提醒通知信息上顯示的按鈕類型和標(biāo)題。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent

WantAgent

點(diǎn)擊提醒通知后跳轉(zhuǎn)的目標(biāo)ability信息。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent

MaxScreenWantAgent

提醒到達(dá)時(shí)自動(dòng)拉起的目標(biāo)ability信息。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent

ReminderRequest

提醒實(shí)例對(duì)象，用于設(shè)置提醒類型、響鈴時(shí)長等具體信息。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent

ReminderRequestCalendar

ReminderRequestCalendar extends ReminderRequest

日歷實(shí)例對(duì)象，用于設(shè)置提醒的時(shí)間。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent

ReminderRequestAlarm

ReminderRequestAlarm extends ReminderRequest

鬧鐘實(shí)例對(duì)象，用于設(shè)置提醒的時(shí)間。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent

ReminderRequestTimer

ReminderRequestTimer extends ReminderRequest

倒計(jì)時(shí)實(shí)例對(duì)象，用于設(shè)置提醒的時(shí)間。

系統(tǒng)能力 ：SystemCapability.Notification.ReminderAgent

LocalDateTime

用于日歷類提醒設(shè)置時(shí)指定時(shí)間信息。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.ReminderAgent