鸿蒙OS ReminderRequest

ReminderRequest

java.lang.Object

|---ohos.event.notification.ReminderRequest

public abstract class ReminderRequest
extends Object
implements Sequenceable, Comparable<ReminderRequest>

让后台代理代表第三方应用程序发布提醒的基类。

第三方应用程序可以使用此类来创建计划提醒，包括用于倒计时、日历事件和活动闹钟的提醒。

调用该类后，调用应用程序的定时和弹出通知功能将由系统服务代理在后台执行，即使应用程序被冻结或退出。 您可以调用 ReminderRequest#setIntentAgent(String, String) 方法来指定是否在录制弹出通知后启动应用程序。

Since:

6

嵌套类摘要

从接口 ohos.utils.Sequenceable 继承的嵌套类/接口
Sequenceable.ProducerT

字段摘要

修饰符和类型	字段	描述
static int	ACTION_BUTTON_TYPE_CLOSE	ActionButton 类型，表示该动作按钮用于关闭提醒的通知。
static int	ACTION_BUTTON_TYPE_SNOOZE	ActionButton 类型，表示该动作按钮用于打盹提醒。

方法总结

修饰符和类型	方法	描述
int	compareTo(ReminderRequest other)	按 triggerTime(RTC) 的升序排序。
boolean	equals(Object obj)	指示其他对象是否“等于”这个对象。
String	getContent()	获取本次提醒的内容。
String	getExpiredContent()	获取该提醒过期时显示的扩展内容。
int	getNotificationId()	获取此提醒使用的通知 ID。
long	getRingDuration()	获取为此提醒配置的响铃或振动持续时间。
String	getSlotId()	获取本次提醒使用的槽位ID。
String	getSnoozeContent()	获取该提醒打盹时显示的扩展内容。
int	getSnoozeTimes()	获取此提醒将被自动延后的次数。
long	getTimeInterval()	获取本次提醒的贪睡间隔。
String	getTitle()	获取此提醒的标题。
int	hashCode()	返回对象的哈希码值。
boolean	marshalling(Parcel out)	将此 Sequenceable 对象编组为 Parcel。
ReminderRequest	setActionButton(String title, int type)	在此提醒的弹出通知屏幕中添加一个 NotificationActionButton。
ReminderRequest	setContent(String content)	设置此提醒的内容。
ReminderRequest	setExpiredContent(String expiredContent)	设置此提醒到期时显示的扩展内容。
ReminderRequest	setIntentAgent(String pkgName, String abilityName)	设置有关在用户点击为此提醒显示的通知后重定向到的目标能力的信息。
ReminderRequest	setMaxScreenIntentAgent(String pkgName, String abilityName)	设置在设备不使用时根据给定的 maxScreenIntentAgent 启动的能力，而不是在状态栏中显示此提醒的通知。
ReminderRequest	setNotificationId(int notificationId)	设置此提醒的通知 ID。
ReminderRequest	setRingDuration(long ringDurationInSeconds)	设置此提醒的响铃或振动持续时间，以秒为单位。
ReminderRequest	setSlotId(String slotId)	设置此提醒的槽 ID。
ReminderRequest	setSnoozeContent(String snoozeContent)	设置此提醒暂停时显示的扩展内容。
ReminderRequest	setSnoozeTimes(int snoozeTimes)	设置此提醒的贪睡次数。v
ReminderRequest	setTimeInterval(long timeIntervalInSeconds)	设置此提醒的贪睡间隔，以秒为单位。
ReminderRequest	setTitle(String title)	设置此提醒的标题。
String	toString()	返回对象的字符串表示形式。
boolean	unmarshalling(Parcel in)	从 Parcel 中解组此 Sequenceable 对象。

从类 java.lang.Object 继承的方法
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口 ohos.utils.Sequenceable 继承的方法
hasFileDescriptor

字段详细信息

ACTION_BUTTON_TYPE_CLOSE

public static final int ACTION_BUTTON_TYPE_CLOSE

ActionButton 类型，表示该动作按钮用于关闭提醒的通知。 无论应用程序当时是否正在运行，它总是运行良好。

ACTION_BUTTON_TYPE_SNOOZE

public static final int ACTION_BUTTON_TYPE_SNOOZE

ActionButton 类型，表示该动作按钮用于打盹提醒。 无论应用程序当时是否正在运行，它总是运行良好。

方法详情

getRingDuration

public long getRingDuration()

获取为此提醒配置的响铃或振动持续时间。

返回:

返回振铃或振动持续时间，以秒为单位。

Since:

6

setRingDuration

public ReminderRequest setRingDuration(long ringDurationInSeconds)

设置此提醒的响铃或振动持续时间，以秒为单位。

参数：

参数名称	参数描述
ringDurationInSeconds	指示要设置的警报持续时间。 默认持续时间为 1 秒。如果 ringDuration 的值小于 0，则设置不生效，使用默认值 1。如果 ringDuration 的值大于 0，设备会一直响铃或振动 指定的秒数。

返回:

返回此 ReminderRequest 实例。

Since:

6

getSnoozeTimes

public int getSnoozeTimes()

获取此提醒将被自动延后的次数。

返回:

返回贪睡的次数。

Since:

6

setSnoozeTimes

public ReminderRequest setSnoozeTimes(int snoozeTimes)

设置此提醒的贪睡次数。

• 如果 snoozeTimes 的值小于等于 0，则本次提醒为一次性提醒，不会被打盹。
• 如果 snoozeTimes 的值大于 0，例如 3，则本次提醒在第一次闹钟响起后会被贪睡 3 次，即本次提醒会被触发 4 次。
• 此方法对倒计时提醒无效。

参数：

参数名称	参数描述
snoozeTimes	指示提醒将被延后的次数。

返回:

返回此 ReminderRequest 实例。

Since:

6

getTimeInterval

public long getTimeInterval()

获取本次提醒的贪睡间隔。

返回:

返回贪睡间隔，以秒为单位。

Since:

6

setTimeInterval

public ReminderRequest setTimeInterval(long timeIntervalInSeconds)

设置此提醒的贪睡间隔，以秒为单位。 默认值为 0。

1. 最小贪睡间隔为 5 分钟。 如果贪睡间隔设置为大于 0 且小于 5 分钟的值，系统默认将其转换为 5 分钟。
2. 该方法对 ReminderRequestTimer 不生效