public enum NotificationState extends java.lang.Enum<NotificationState>
NotificationEntry is currently in, such as
new, completed, or favorated. This list is
intended to be comprehensive, but new states may be added in the future as
needed. Notification data sources are afforded reasonable latitude as to
when and how a notification enters into a state. All states are
optional. View implementations vary as to how they represent a state
to a user, or whether they represent it.| Enum Constant and Description |
|---|
ACKNOWLEDGED
Indicates the user has signaled receipt of the
NotificationEntry,
typically because the sender of the notification requested it. |
ARCHIVED
Indicates the
NotificationEntry is no longer in the user's active
notifications. |
COMPLETED
Indicates the
NotificationEntry is about a task that is completed. |
EMAILED
Indicates the recipient was sent an email about the
NotificationEntry. |
FAVORITED
Indicates the user "starred" or "favorited" the
NotificationEntry. |
IN_PROGRESS
Indicates the
NotificationEntry is about a task that is partially
completed.. |
ISSUED
Registered when the
NotificationEntry is assigned to an
individual. |
PUSHED
Indicates the
NotificationEntry has been pushed to a mobile
device. |
READ
Indicates that (at minimum) the title of the
NotificationEntry
was displayed to to the recipient. |
SNOOZED
Indicates the user dismissed the
NotificationEntry
temporarily. |
TEXTED
Indicates the recipient was sent an SMS message to alert him or her about
the
NotificationEntry. |
UPDATED
Indicates one or more fields of the
NotificationEntry were
modified after it was created. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
isActive(java.util.Date timestamp,
java.util.Set<NotificationState> subsequentHistory)
Indicates whether this
NotificationState is still considered
"active" given when it occurred (the specified timestamp) and the
subsequent history of the NotificationEntry for this user. |
static NotificationState |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static NotificationState[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final NotificationState ISSUED
NotificationEntry is assigned to an
individual. Represents the creation date of a notification vis-a-vis a
recipient.public static final NotificationState UPDATED
NotificationEntry were
modified after it was created.public static final NotificationState PUSHED
NotificationEntry has been pushed to a mobile
device.public static final NotificationState TEXTED
NotificationEntry.public static final NotificationState EMAILED
NotificationEntry.public static final NotificationState READ
NotificationEntry
was displayed to to the recipient. Notifications with the
READ state may be considered no longer new.public static final NotificationState ACKNOWLEDGED
NotificationEntry,
typically because the sender of the notification requested it.public static final NotificationState FAVORITED
NotificationEntry.
This state must be removed if the user later undoes the action.public static final NotificationState SNOOZED
NotificationEntry
temporarily. This state must be removed after a (probably configurable)
period has elapsed.public static final NotificationState IN_PROGRESS
NotificationEntry is about a task that is partially
completed..public static final NotificationState COMPLETED
NotificationEntry is about a task that is completed.public static final NotificationState ARCHIVED
NotificationEntry is no longer in the user's active
notifications. Notifications may be archived by user action or by system
rules.public static NotificationState[] values()
for (NotificationState c : NotificationState.values()) System.out.println(c);
public static NotificationState valueOf(java.lang.String name)
name - the name of the enum constant to be returned.java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is nullpublic boolean isActive(java.util.Date timestamp,
java.util.Set<NotificationState> subsequentHistory)
NotificationState is still considered
"active" given when it occurred (the specified timestamp) and the
subsequent history of the NotificationEntry for this user. Most
states can use the default implementation of this method, which simply
returns true. States that may be effectively "canceled" by
other states -- or by the passage of time -- should override this method.timestamp - The moment when this state was appliedsubsequentHistory - States that were applied to this
NotificationEntry for this user after this one.NotificationEntry for this user