HarmonyOS API:@ohos.reminderAgent (后台代理提醒)

joytrian
发布于 2023-4-12 18:10
浏览
0收藏

版本:v3.1 Beta

@ohos.reminderAgent (后台代理提醒)

更新时间: 2023-02-17 09:19


本模块提供后台代理提醒的能力。


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


说明

从API Version 9 开始,该接口不再维护,推荐使用新接口​​@ohos.reminderAgentManager (后台代理提醒)​

本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import reminderAgent from'@ohos.reminderAgent';

reminderAgent.publishReminder

publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void

发布一个后台代理提醒,使用callback方式实现异步调用,该方法需要申请通知弹窗​​Notification.requestEnableNotification​​后才能调用。

需要权限: ohos.permission.PUBLISH_AGENT_REMINDER

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

reminderReq

​ReminderRequest​

需要发布的提醒实例。

callback

AsyncCallback<number>

异步回调,返回当前发布的提醒的reminderId。

示例

  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<number>

发布一个后台代理提醒,使用Promise方式实现异步调用,该方法需要申请通知弹窗​​Notification.requestEnableNotification​​后才能调用。

需要权限: ohos.permission.PUBLISH_AGENT_REMINDER

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

reminderReq

​ReminderRequest​

需要发布的提醒实例。

返回值

类型

说明

Promise<number>

返回提醒的reminderId。

示例

  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>): void

取消指定id的提醒,使用callback方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

reminderId

number

目标reminder的id号,​​publishReminder​​方法调用成功后获得。

callback

AsyncCallback<void>

异步回调。

示例

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

reminderAgent.cancelReminder

cancelReminder(reminderId: number): Promise<void>

取消指定id的提醒,使用Promise方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

reminderId

number

目标reminder的id号,​​publishReminder​​方法调用成功后获得。

返回值

类型

说明

Promise<void>

Promise类型异步回调。

示例

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

reminderAgent.getValidReminders

getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void

获取当前应用已设置的所有有效(未过期)的提醒,使用callback方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

callback

AsyncCallback<Array<​​ReminderRequest​​>>

异步回调,返回当前应用已设置的所有有效(未过期)的提醒。

示例

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<Array<ReminderRequest>>

获取当前应用已设置的所有有效(未过期)的提醒,使用Promise方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

返回值

类型

说明

Promise<Array<​​ReminderRequest​​>>

返回当前应用已设置的所有有效(未过期)的提醒。

示例

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>): void

取消当前应用所有的提醒,使用callback方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

callback

AsyncCallback<void>

异步回调。

示例

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

reminderAgent.cancelAllReminders

cancelAllReminders(): Promise<void>

取消当前应用所有的提醒,使用Promise方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

返回值

类型

说明

Promise<void>

Promise类型异步回调。

示例

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

reminderAgent.addNotificationSlot

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

添加一个NotificationSlot,使用callback方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

slot

​NotificationSlot​

notification slot实例,仅支持设置其type属性。

callback

AsyncCallback<void>

异步回调。

示例

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<void>

添加一个NotificationSlot,使用Promise方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

slot

​NotificationSlot​

notification slot实例,仅支持设置其type属性。

返回值

类型

说明

Promise<void>

Promise类型异步回调。

示例

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>): void

删除目标NotificationSlot,使用callback方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

slotType

​notification.SlotType​

目标notification slot的类型。

callback

AsyncCallback<void>

异步回调。

示例

import notification from '@ohos.notification'

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

reminderAgent.removeNotificationSlot

removeNotificationSlot(slotType: notification.SlotType): Promise<void>

删除目标NotificationSlot,使用Promise方式实现异步调用。

系统能力: SystemCapability.Notification.ReminderAgent

参数

参数名

类型

必填

说明

slotType

​notification.SlotType​

目标notification slot的类型。

返回值

类型

说明

Promise<void>

Promise类型异步回调。

示例

import notification from '@ohos.notification'

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

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​

弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。

wantAgent

​WantAgent​

点击通知后需要跳转的目标ability信息。

maxScreenWantAgent

​MaxScreenWantAgent​

提醒到达时跳转的目标包。如果设备正在使用中,则弹出一个通知框。

ringDuration

number

指明响铃时长(单位:秒),默认1秒。

snoozeTimes

number

指明延迟提醒次数,默认0次。

timeInterval

number

执行延迟提醒间隔(单位:秒),默认0秒。

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>

指明每周哪几天需要重复提醒。 范围为周一到周末,对应数字为1到7。

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


文章转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-reminderagent-0000001427585172-V3?catalogVersion=V3​

已于2023-4-12 18:10:47修改
收藏
回复
举报
回复
    相关推荐