Save the date! Android Dev Summit is coming to Sunnyvale, CA on Oct 23-24, 2019.

NotificationStats

public final class NotificationStats
extends Object implements Parcelable

java.lang.Object
   ↳ android.service.notification.NotificationStats


Summary

Constants

int DISMISSAL_AOD

Notification has been dismissed from always on display.

int DISMISSAL_NOT_DISMISSED

Notification has not been dismissed yet.

int DISMISSAL_OTHER

Notification has been dismissed from a NotificationListenerService or the app itself.

int DISMISSAL_PEEK

Notification has been dismissed while peeking.

int DISMISSAL_SHADE

Notification has been dismissed from the notification shade.

int DISMISS_SENTIMENT_NEGATIVE

The user indicated while dismissing that they did not like the notification.

int DISMISS_SENTIMENT_NEUTRAL

The user didn't indicate one way or another how they felt about the notification while dismissing it.

int DISMISS_SENTIMENT_POSITIVE

The user indicated while dismissing that they did like the notification.

int DISMISS_SENTIMENT_UNKNOWN

No information is available about why this notification was dismissed, or the notification isn't dismissed yet.

Inherited constants

Fields

public static final Creator<NotificationStats> CREATOR

Public constructors

NotificationStats()

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

int getDismissalSentiment()

Returns how the user indicated they felt about a notification before or during dismissal.

int getDismissalSurface()

Returns from which surface the notification was dismissed.

boolean hasDirectReplied()

Returns whether the user has replied to a notification that has a direct reply at least once.

boolean hasExpanded()

Returns whether the user has expanded this notification at least once.

boolean hasInteracted()

Returns whether the user has interacted with this notification beyond having viewed it.

boolean hasSeen()

Returns whether the user has seen this notification at least once.

boolean hasSnoozed()

Returns whether the user has snoozed this notification at least once.

boolean hasViewedSettings()

Returns whether the user has viewed the in-shade settings for this notification at least once.

int hashCode()

Returns a hash code value for the object.

void setDirectReplied()

Records that the user has replied to a notification that has a direct reply at least once.

void setDismissalSentiment(int dismissalSentiment)

Records whether the user indicated how they felt about a notification before or during dismissal.

void setDismissalSurface(int dismissalSurface)

Returns from which surface the notification was dismissed.

void setExpanded()

Records that the user has expanded this notification at least once.

void setSeen()

Records that the user as seen this notification at least once.

void setSnoozed()

Records that the user has snoozed this notification at least once.

void setViewedSettings()

Records that the user has viewed the in-shade settings for this notification at least once.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

DISMISSAL_AOD

public static final int DISMISSAL_AOD

Notification has been dismissed from always on display.

Constant Value: 2 (0x00000002)

DISMISSAL_NOT_DISMISSED

public static final int DISMISSAL_NOT_DISMISSED

Notification has not been dismissed yet.

Constant Value: -1 (0xffffffff)

DISMISSAL_OTHER

public static final int DISMISSAL_OTHER

Notification has been dismissed from a NotificationListenerService or the app itself.

Constant Value: 0 (0x00000000)

DISMISSAL_PEEK

public static final int DISMISSAL_PEEK

Notification has been dismissed while peeking.

Constant Value: 1 (0x00000001)

DISMISSAL_SHADE

public static final int DISMISSAL_SHADE

Notification has been dismissed from the notification shade.

Constant Value: 3 (0x00000003)

DISMISS_SENTIMENT_NEGATIVE

public static final int DISMISS_SENTIMENT_NEGATIVE

The user indicated while dismissing that they did not like the notification.

Constant Value: 0 (0x00000000)

DISMISS_SENTIMENT_NEUTRAL

public static final int DISMISS_SENTIMENT_NEUTRAL

The user didn't indicate one way or another how they felt about the notification while dismissing it.

Constant Value: 1 (0x00000001)

DISMISS_SENTIMENT_POSITIVE

public static final int DISMISS_SENTIMENT_POSITIVE

The user indicated while dismissing that they did like the notification.

Constant Value: 2 (0x00000002)

DISMISS_SENTIMENT_UNKNOWN

public static final int DISMISS_SENTIMENT_UNKNOWN

No information is available about why this notification was dismissed, or the notification isn't dismissed yet.

Constant Value: -1000 (0xfffffc18)

Fields

CREATOR

public static final Creator<NotificationStats> CREATOR

Public constructors

NotificationStats

public NotificationStats ()

Public methods

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

public boolean equals (Object o)

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.

Parameters
o Object: the reference object with which to compare.

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

getDismissalSentiment

public int getDismissalSentiment ()

Returns how the user indicated they felt about a notification before or during dismissal.

Returns
int Value is DISMISS_SENTIMENT_UNKNOWN, DISMISS_SENTIMENT_NEGATIVE, DISMISS_SENTIMENT_NEUTRAL, or DISMISS_SENTIMENT_POSITIVE

getDismissalSurface

public int getDismissalSurface ()

Returns from which surface the notification was dismissed.

Returns
int Value is DISMISSAL_NOT_DISMISSED, DISMISSAL_OTHER, DISMISSAL_PEEK, DISMISSAL_AOD, or DISMISSAL_SHADE

hasDirectReplied

public boolean hasDirectReplied ()

Returns whether the user has replied to a notification that has a direct reply at least once.

Returns
boolean

hasExpanded

public boolean hasExpanded ()

Returns whether the user has expanded this notification at least once.

Returns
boolean

hasInteracted

public boolean hasInteracted ()

Returns whether the user has interacted with this notification beyond having viewed it.

Returns
boolean

hasSeen

public boolean hasSeen ()

Returns whether the user has seen this notification at least once.

Returns
boolean

hasSnoozed

public boolean hasSnoozed ()

Returns whether the user has snoozed this notification at least once.

Returns
boolean

hasViewedSettings

public boolean hasViewedSettings ()

Returns whether the user has viewed the in-shade settings for this notification at least once.

Returns
boolean

hashCode

public int hashCode ()

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 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.)

Returns
int a hash code value for this object.

setDirectReplied

public void setDirectReplied ()

Records that the user has replied to a notification that has a direct reply at least once.

setDismissalSentiment

public void setDismissalSentiment (int dismissalSentiment)

Records whether the user indicated how they felt about a notification before or during dismissal.

Parameters
dismissalSentiment int: Value is DISMISS_SENTIMENT_UNKNOWN, DISMISS_SENTIMENT_NEGATIVE, DISMISS_SENTIMENT_NEUTRAL, or DISMISS_SENTIMENT_POSITIVE

setDismissalSurface

public void setDismissalSurface (int dismissalSurface)

Returns from which surface the notification was dismissed.

Parameters
dismissalSurface int: Value is DISMISSAL_NOT_DISMISSED, DISMISSAL_OTHER, DISMISSAL_PEEK, DISMISSAL_AOD, or DISMISSAL_SHADE

setExpanded

public void setExpanded ()

Records that the user has expanded this notification at least once.

setSeen

public void setSeen ()

Records that the user as seen this notification at least once.

setSnoozed

public void setSnoozed ()

Records that the user has snoozed this notification at least once.

setViewedSettings

public void setViewedSettings ()

Records that the user has viewed the in-shade settings for this notification at least once.

toString

public String toString ()

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())
 

Returns
String a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES