ReminderRequest

java.lang.Object
- ohos.event.notification.ReminderRequest

所有已实现的接口:

Comparable<ReminderRequest>, Sequenceable

直接已知子类:

ReminderRequestAlarm, ReminderRequestCalendar, ReminderRequestTimer
```
public abstract class ReminderRequest
extends Object
implements Sequenceable, Comparable<ReminderRequest>
```
Base class for letting a background agent to publish reminders on behalf of a third-party application.
Third-party applications can use this class to create scheduled reminders, including those for countdown timers, calendar events, and active alarm clocks.
After this class is called, the timing and pop-up notification functions of the calling application will be performed by the system service agent in the background, even when the application is frozen or exits. You can call the ReminderRequest#setIntentAgent(String, String) method to specify whether to start the application after the pop-up notification is taped.

从以下版本开始:

6

另请参阅:

ReminderHelper.publishReminder(ReminderRequest), ReminderRequestTimer, ReminderRequestCalendar, ReminderRequestAlarm

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`static int`	`ACTION_BUTTON_TYPE_CLOSE`	ActionButton type, indicates that this action button is used to close reminder's notification.
`static int`	`ACTION_BUTTON_TYPE_SNOOZE`	ActionButton type, indicates that this action button is used to snooze reminder.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`int`	`compareTo(ReminderRequest other)`	Sorted by ascending order of triggerTime(RTC).
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`String`	`getContent()`	Obtains the content of this reminder.
`String`	`getExpiredContent()`	Obtains the extended content displayed when this reminder expires.
`int`	`getNotificationId()`	Obtains the notification ID used by this reminder.
`long`	`getRingDuration()`	Obtains the ringing or vibration duration configured for this reminder.
`String`	`getSlotId()`	Obtains the slot ID used by this reminder.
`String`	`getSnoozeContent()`	Obtains the extended content displayed when this reminder is snoozing.
`int`	`getSnoozeTimes()`	Obtains the number of times this reminder will be automatically snoozed.
`long`	`getTimeInterval()`	Obtains the snooze interval of this reminder.
`String`	`getTitle()`	Obtains the title of this reminder.
`int`	`hashCode()`	Returns a hash code value for the object.
`boolean`	`marshalling(Parcel out)`	Marshals this `Sequenceable` object into a `Parcel`.
`ReminderRequest`	`setActionButton(String title, int type)`	Adds a `NotificationActionButton` to the pop-up notification screen of this reminder.
`ReminderRequest`	`setContent(String content)`	Sets the content of this reminder.
`ReminderRequest`	`setExpiredContent(String expiredContent)`	Sets the extended content to be displayed when this reminder expires.
`ReminderRequest`	`setIntentAgent(String pkgName, String abilityName)`	Sets information about the target ability to be redirected to after the user taps the notification displayed for this reminder.
`ReminderRequest`	`setMaxScreenIntentAgent(String pkgName, String abilityName)`	Sets the ability to be started based on the given `maxScreenIntentAgent` when the device is not in use, instead of showing a notification for this reminder in the status bar.
`ReminderRequest`	`setNotificationId(int notificationId)`	Sets the notification ID for this reminder.
`ReminderRequest`	`setRingDuration(long ringDurationInSeconds)`	Sets the ringing or vibration duration for this reminder, in seconds.
`ReminderRequest`	`setSlotId(String slotId)`	Sets the slot ID for this reminder.
`ReminderRequest`	`setSnoozeContent(String snoozeContent)`	Sets the extended content to be displayed when this reminder is snoozing.
`ReminderRequest`	`setSnoozeTimes(int snoozeTimes)`	Sets the number of snooze times for this reminder.
`ReminderRequest`	`setTimeInterval(long timeIntervalInSeconds)`	Sets the snooze interval for this reminder, in seconds.
`ReminderRequest`	`setTitle(String title)`	Sets the title of this reminder.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals this `Sequenceable` object from a `Parcel`.

从类继承的方法 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 type, indicates that this action button is used to close reminder's notification. It always works well, whether the application is running at the time.
    
    另请参阅:
    
    常量字段值
  - ACTION_BUTTON_TYPE_SNOOZE
```
public static final int ACTION_BUTTON_TYPE_SNOOZE
```
    ActionButton type, indicates that this action button is used to snooze reminder. It always works well, whether the application is running at the time.
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getRingDuration
```
public long getRingDuration()
```
    Obtains the ringing or vibration duration configured for this reminder.
    
    返回:
    
    Returns the ringing or vibration duration, in seconds.
    
    从以下版本开始:
    
    6
  - setRingDuration
```
public ReminderRequest setRingDuration(long ringDurationInSeconds)
```
    Sets the ringing or vibration duration for this reminder, in seconds.
    参数:
    ringDurationInSeconds - Indicates the alarm duration to set. The default duration is 1 second.
    
    If the value of ringDuration is less than 0, the setting does not take effect, and the default value 1 is used.
    
    If the value of ringDuration is greater than 0, the device keeps ringing or vibrating for the specified number of seconds.
    返回:
    
    Returns this ReminderRequest instance.
    
    从以下版本开始:
    
    6
  - getSnoozeTimes
```
public int getSnoozeTimes()
```
    Obtains the number of times this reminder will be automatically snoozed.
    
    返回:
    
    Returns the number of snooze times.
    
    从以下版本开始:
    
    6
  - setSnoozeTimes
```
public ReminderRequest setSnoozeTimes(int snoozeTimes)
```
    Sets the number of snooze times for this reminder.
    - If the value of snoozeTimes is less than or equal to 0, this reminder is a one-shot reminder and will not be snoozed.
    - If the value of snoozeTimes is greater than 0, for example, 3, this reminder will be snoozed three times after the first alarm, that is, this reminder will be triggered for four times.
    - This method does not take effect on the reminders for countdown timers.
    参数:
    
    snoozeTimes - Indicates the number of times that the reminder will be snoozed.
    
    返回:
    
    Returns this ReminderRequest instance.
    
    从以下版本开始:
    
    6
  - getTimeInterval
```
public long getTimeInterval()
```
    Obtains the snooze interval of this reminder.
    
    返回:
    
    Returns the snooze interval, in seconds.
    
    从以下版本开始:
    
    6
  - setTimeInterval
```
public ReminderRequest setTimeInterval(long timeIntervalInSeconds)
```
    Sets the snooze interval for this reminder, in seconds. The default value is 0.
    1. The minimum snooze interval is 5 minutes. If the snooze interval is set to a value greater than 0 and less than 5 minutes, the system converts it to 5 minutes by default.
    2. This method does not take effect on ReminderRequestTimer

参数:: timeIntervalInSeconds - Indicates the snooze interval to set. If the value is less than or equal to 0, the reminder will not be snoozed.
返回:: Returns this ReminderRequest instance.
从以下版本开始:: 6

getTitle
```
public String getTitle()
```
Obtains the title of this reminder.

返回:

Returns the reminder title.

从以下版本开始:

6

setTitle
```
public ReminderRequest setTitle(String title)
```
Sets the title of this reminder.

参数:

title - Indicates the title to display.

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

getContent
```
public String getContent()
```
Obtains the content of this reminder.

返回:

Returns the reminder content.

从以下版本开始:

6

setContent
```
public ReminderRequest setContent(String content)
```
Sets the content of this reminder.

参数:

content - Indicates the content to display.

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

getExpiredContent
```
public String getExpiredContent()
```
Obtains the extended content displayed when this reminder expires.

返回:

Returns the extended content displayed when this reminder expires.

从以下版本开始:

6

setExpiredContent
```
public ReminderRequest setExpiredContent(String expiredContent)
```
Sets the extended content to be displayed when this reminder expires.

参数:

expiredContent - Indicates the extended content to be displayed when this reminder expires, for example, "Expired".

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

getSnoozeContent
```
public String getSnoozeContent()
```
Obtains the extended content displayed when this reminder is snoozing.

返回:

Returns the extended content displayed when this reminder is snoozing.

从以下版本开始:

6

setSnoozeContent
```
public ReminderRequest setSnoozeContent(String snoozeContent)
```
Sets the extended content to be displayed when this reminder is snoozing.

参数:

snoozeContent - Indicates the extended content to be displayed when this reminder is snoozing, for example, "Remind later".

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

getNotificationId
```
public int getNotificationId()
```
Obtains the notification ID used by this reminder.

返回:

Returns the notification ID of this reminder.

从以下版本开始:

6

另请参阅:

NotificationRequest.getNotificationId()

setNotificationId
```
public ReminderRequest setNotificationId(int notificationId)
```
Sets the notification ID for this reminder.

参数:

notificationId - Indicates the notification ID to set.

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

另请参阅:

NotificationRequest.setNotificationId(int)

getSlotId
```
public String getSlotId()
```
Obtains the slot ID used by this reminder.

返回:

Returns the slot ID of this reminder.

从以下版本开始:

6

另请参阅:

NotificationRequest.getSlotId()

setSlotId
```
public ReminderRequest setSlotId(String slotId)
```
Sets the slot ID for this reminder.

参数:

slotId - Indicates the slot ID to set.

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

另请参阅:

NotificationRequest.setSlotId(String)

setActionButton
```
public ReminderRequest setActionButton(String title,
                                       int type)
```
Adds a NotificationActionButton to the pop-up notification screen of this reminder. The system typically places action buttons below the notification content.
Icons cannot be configured for NotificationActionButtons.
The system automatically sets an IntentAgent for the NotificationActionButton instance based on the value of the type parameter.
A maximum of two NotificationActionButton instances can be added for each reminder. One NotificationActionButton is of the ACTION_BUTTON_TYPE_CLOSE type, and the other is of the ACTION_BUTTON_TYPE_SNOOZE type.

参数:

title - Indicates the button name.

type - Indicates the type of the action button to add, which can be ACTION_BUTTON_TYPE_CLOSE or ACTION_BUTTON_TYPE_SNOOZE.

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

setMaxScreenIntentAgent
```
public ReminderRequest setMaxScreenIntentAgent(String pkgName,
                                               String abilityName)
```
Sets the ability to be started based on the given maxScreenIntentAgent when the device is not in use, instead of showing a notification for this reminder in the status bar.
When the device is in use, the system UI displays a pop-up notification instead of starting the ability specified by maxScreenIntentAgent.
Before calling this method, the application must have been granted the ohos.permission.USE_WHOLE_SCREEN permission.

参数:

pkgName - Indicates the HAP package name of the target ability.

abilityName - Indicates the name of the target ability.

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

marshalling
```
public boolean marshalling(Parcel out)
```
从接口复制的说明: Sequenceable

Marshals this Sequenceable object into a Parcel.

指定者:

marshalling 在接口中 Sequenceable

参数:

out - Indicates the Parcel object to which the Sequenceable object will be marshaled..

返回:

Returns true if the marshalling is successful; returns false otherwise.

unmarshalling
```
public boolean unmarshalling(Parcel in)
```
从接口复制的说明: Sequenceable

Unmarshals this Sequenceable object from a Parcel.

指定者:

unmarshalling 在接口中 Sequenceable

参数:

in - Indicates the Parcel object into which the Sequenceable object has been marshaled.

返回:

Returns true if the unmarshalling is successful; returns false otherwise.

compareTo
```
public int compareTo(ReminderRequest other)
```
Sorted by ascending order of triggerTime(RTC).

指定者:

compareTo 在接口中 Comparable<ReminderRequest>

参数:

other - Indicate the object to compare to.

返回:

return 0 if equals, -1 if less than other, and 1 if larger than other.

equals
```
public boolean equals(Object obj)
```
从类复制的说明: Object
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value x, x.equals(x) should return true.
- It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
- It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
- It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
- For any non-null reference value x, x.equals(null) should return false.
The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
覆盖:

equals 在类中 Object

参数:

obj - the reference object with which to compare.

返回:

true if this object is the same as the obj argument; false otherwise.

另请参阅:

Object.hashCode(), HashMap

hashCode
```
public int hashCode()
```
从类复制的说明: Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
- It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
覆盖:

hashCode 在类中 Object

返回:

a hash code value for this object.

另请参阅:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString
```
public String toString()
```
从类复制的说明: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
```
 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
```
覆盖:

toString 在类中 Object

返回:

a string representation of the object.

setIntentAgent
```
public ReminderRequest setIntentAgent(String pkgName,
                                      String abilityName)
```
Sets information about the target ability to be redirected to after the user taps the notification displayed for this reminder.
After the user taps the notification, the IntentAgent will be triggered to start the specified ability.

参数:

pkgName - Indicates the HAP package name of the target ability.

abilityName - Indicates the name of the target ability.

返回:

Returns this ReminderRequest instance.

从以下版本开始:

6

类 ReminderRequest

嵌套类概要

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

字段概要

方法概要

从类继承的方法 java.lang.Object

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

字段详细资料

ACTION_BUTTON_TYPE_CLOSE

ACTION_BUTTON_TYPE_SNOOZE

方法详细资料

getRingDuration

setRingDuration

getSnoozeTimes

setSnoozeTimes

getTimeInterval

setTimeInterval

getTitle

setTitle

getContent

setContent

getExpiredContent

setExpiredContent

getSnoozeContent

setSnoozeContent

getNotificationId

setNotificationId

getSlotId

setSlotId

setActionButton

setMaxScreenIntentAgent

marshalling

unmarshalling

compareTo

equals

hashCode

toString

setIntentAgent