Skip to content

Most visited

Recently visited

navigation

NotificationManager.Policy

public static class NotificationManager.Policy
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.NotificationManager.Policy


Notification policy configuration. Represents user-preferences for notification filtering.

Summary

Constants

int PRIORITY_CATEGORY_CALLS

Calls are prioritized.

int PRIORITY_CATEGORY_EVENTS

Event notifications are prioritized.

int PRIORITY_CATEGORY_MESSAGES

Message notifications are prioritized.

int PRIORITY_CATEGORY_REMINDERS

Reminder notifications are prioritized.

int PRIORITY_CATEGORY_REPEAT_CALLERS

Calls from repeat callers are prioritized.

int PRIORITY_SENDERS_ANY

Any sender is prioritized.

int PRIORITY_SENDERS_CONTACTS

Saved contacts are prioritized.

int PRIORITY_SENDERS_STARRED

Only starred contacts are prioritized.

int SUPPRESSED_EFFECT_SCREEN_OFF

Whether notifications suppressed by DND should not interrupt visually (e.g.

int SUPPRESSED_EFFECT_SCREEN_ON

Whether notifications suppressed by DND should not interrupt visually when the screen is on (e.g.

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<NotificationManager.Policy> CREATOR

public final int priorityCallSenders

Notification senders to prioritize for calls.

public final int priorityCategories

Notification categories to prioritize.

public final int priorityMessageSenders

Notification senders to prioritize for messages.

public final int suppressedVisualEffects

Visual effects to suppress for a notification that is filtered by Do Not Disturb mode.

Public constructors

NotificationManager.Policy(int priorityCategories, int priorityCallSenders, int priorityMessageSenders)

Constructs a policy for Do Not Disturb priority mode behavior.

NotificationManager.Policy(int priorityCategories, int priorityCallSenders, int priorityMessageSenders, int suppressedVisualEffects)

Constructs a policy for Do Not Disturb priority mode behavior.

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

Returns a hash code value for the object.

static String priorityCategoriesToString(int priorityCategories)
static String prioritySendersToString(int prioritySenders)
static String suppressedEffectsToString(int effects)
String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

PRIORITY_CATEGORY_CALLS

added in API level 23
int PRIORITY_CATEGORY_CALLS

Calls are prioritized.

Constant Value: 8 (0x00000008)

PRIORITY_CATEGORY_EVENTS

added in API level 23
int PRIORITY_CATEGORY_EVENTS

Event notifications are prioritized.

Constant Value: 2 (0x00000002)

PRIORITY_CATEGORY_MESSAGES

added in API level 23
int PRIORITY_CATEGORY_MESSAGES

Message notifications are prioritized.

Constant Value: 4 (0x00000004)

PRIORITY_CATEGORY_REMINDERS

added in API level 23
int PRIORITY_CATEGORY_REMINDERS

Reminder notifications are prioritized.

Constant Value: 1 (0x00000001)

PRIORITY_CATEGORY_REPEAT_CALLERS

added in API level 23
int PRIORITY_CATEGORY_REPEAT_CALLERS

Calls from repeat callers are prioritized.

Constant Value: 16 (0x00000010)

PRIORITY_SENDERS_ANY

added in API level 23
int PRIORITY_SENDERS_ANY

Any sender is prioritized.

Constant Value: 0 (0x00000000)

PRIORITY_SENDERS_CONTACTS

added in API level 23
int PRIORITY_SENDERS_CONTACTS

Saved contacts are prioritized.

Constant Value: 1 (0x00000001)

PRIORITY_SENDERS_STARRED

added in API level 23
int PRIORITY_SENDERS_STARRED

Only starred contacts are prioritized.

Constant Value: 2 (0x00000002)

SUPPRESSED_EFFECT_SCREEN_OFF

added in API level 24
int SUPPRESSED_EFFECT_SCREEN_OFF

Whether notifications suppressed by DND should not interrupt visually (e.g. with notification lights or by turning the screen on) when the screen is off.

Constant Value: 1 (0x00000001)

SUPPRESSED_EFFECT_SCREEN_ON

added in API level 24
int SUPPRESSED_EFFECT_SCREEN_ON

Whether notifications suppressed by DND should not interrupt visually when the screen is on (e.g. by peeking onto the screen).

Constant Value: 2 (0x00000002)

Fields

CREATOR

added in API level 23
Creator<NotificationManager.Policy> CREATOR

priorityCallSenders

added in API level 23
int priorityCallSenders

Notification senders to prioritize for calls. One of: PRIORITY_SENDERS_ANY, PRIORITY_SENDERS_CONTACTS, PRIORITY_SENDERS_STARRED

priorityCategories

added in API level 23
int priorityCategories

Notification categories to prioritize. Bitmask of PRIORITY_CATEGORY_* constants.

priorityMessageSenders

added in API level 23
int priorityMessageSenders

Notification senders to prioritize for messages. One of: PRIORITY_SENDERS_ANY, PRIORITY_SENDERS_CONTACTS, PRIORITY_SENDERS_STARRED

suppressedVisualEffects

added in API level 24
int suppressedVisualEffects

Visual effects to suppress for a notification that is filtered by Do Not Disturb mode. Bitmask of SUPPRESSED_EFFECT_* constants.

Public constructors

NotificationManager.Policy

added in API level 23
NotificationManager.Policy (int priorityCategories, 
                int priorityCallSenders, 
                int priorityMessageSenders)

Constructs a policy for Do Not Disturb priority mode behavior.

Parameters
priorityCategories int: bitmask of categories of notifications that can bypass DND.
priorityCallSenders int: which callers can bypass DND.
priorityMessageSenders int: which message senders can bypass DND.

NotificationManager.Policy

added in API level 24
NotificationManager.Policy (int priorityCategories, 
                int priorityCallSenders, 
                int priorityMessageSenders, 
                int suppressedVisualEffects)

Constructs a policy for Do Not Disturb priority mode behavior.

Parameters
priorityCategories int: bitmask of categories of notifications that can bypass DND.
priorityCallSenders int: which callers can bypass DND.
priorityMessageSenders int: which message senders can bypass DND.
suppressedVisualEffects int: which visual interruptions should be suppressed from notifications that are filtered by DND.

Public methods

describeContents

added in API level 23
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(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.

equals

added in API level 23
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.

hashCode

added in API level 23
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.

priorityCategoriesToString

added in API level 23
String priorityCategoriesToString (int priorityCategories)

Parameters
priorityCategories int
Returns
String

prioritySendersToString

added in API level 23
String prioritySendersToString (int prioritySenders)

Parameters
prioritySenders int
Returns
String

suppressedEffectsToString

added in API level 24
String suppressedEffectsToString (int effects)

Parameters
effects int
Returns
String

toString

added in API level 23
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

added in API level 23
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_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.