# Print output for @column tags ?> ZenPolicy - Android SDK | Android Developers
Developer Console

Most visited

Recently visited

Results for

ZenPolicy

public final class ZenPolicy
extends Object implements Parcelable

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

ZenPolicy determines whether to allow certain notifications and their corresponding sounds to play when a device is in Do Not Disturb mode. ZenPolicy also dictates the visual effects of notifications that are intercepted when a device is in Do Not Disturb mode.

Summary

Nested classes

class ZenPolicy.Builder

Builder class for ZenPolicy objects. 

Constants

int CONVERSATION_SENDERS_ANYONE

Used to indicate all conversations can bypass dnd.

int CONVERSATION_SENDERS_IMPORTANT

Used to indicate important conversations can bypass dnd.

int CONVERSATION_SENDERS_NONE

Used to indicate no conversations can bypass dnd.

int CONVERSATION_SENDERS_UNSET

Used to indicate no preference for the type of conversations that can bypass dnd.

int PEOPLE_TYPE_ANYONE

Used to indicate all calls or messages can bypass dnd.

int PEOPLE_TYPE_CONTACTS

Used to indicate calls or messages from contacts can bypass dnd.

int PEOPLE_TYPE_NONE

Used to indicate no calls or messages can bypass dnd.

int PEOPLE_TYPE_STARRED

Used to indicate calls or messages from starred contacts can bypass dnd.

int PEOPLE_TYPE_UNSET

Used to indicate no preference for the type of people that can bypass dnd for either calls or messages.

int STATE_ALLOW

Indicates a type of sound or visual effect is allowed to play/show when DND is active.

int STATE_DISALLOW

Indicates a type of sound or visual effect is not allowed to play/show when DND is active.

int STATE_UNSET

Indicates no preference for whether a type of sound or visual effect is or isn't allowed to play/show when DND is active.

Inherited constants

Fields

public static final Creator<ZenPolicy> CREATOR

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

Callers that can bypass DND.

int getPriorityCategoryAlarms()

Whether this policy wants to allow notifications with category Notification#CATEGORY_ALARM to play sounds and visually appear or to intercept them when DND is active.

int getPriorityCategoryCalls()

Whether this policy wants to allow notifications with category Notification#CATEGORY_CALL to play sounds and visually appear or to intercept them when DND is active.

int getPriorityCategoryConversations()

Whether this policy wants to allow conversation notifications (see NotificationChannel#getConversationId()) to play sounds and visually appear or to intercept them when DND is active.

int getPriorityCategoryEvents()

Whether this policy wants to allow notifications with category Notification#CATEGORY_EVENT to play sounds and visually appear or to intercept them when DND is active.

int getPriorityCategoryMedia()

Whether this policy wants to allow media notifications to play sounds and visually appear or to intercept them when DND is active.

int getPriorityCategoryMessages()

Whether this policy wants to allow notifications with category Notification#CATEGORY_MESSAGE to play sounds and visually appear or to intercept them when DND is active.

int getPriorityCategoryReminders()

Whether this policy wants to allow notifications with category Notification#CATEGORY_REMINDER to play sounds and visually appear or to intercept them when DND is active.

int getPriorityCategoryRepeatCallers()

Whether this policy wants to allow repeat callers (notifications with category Notification#CATEGORY_CALL that have recently called) to play sounds and visually appear or to intercept them when DND is active.

int getPriorityCategorySystem()

Whether this policy wants to allow system sounds when DND is active.

int getPriorityConversationSenders()

Conversation type that can bypass DND.

int getPriorityMessageSenders()

Message senders that can bypass DND.

int getVisualEffectAmbient()

Whether this policy allows notifications intercepted by DND from appearing on ambient displays on devices that support ambient display.

int getVisualEffectBadge()

Whether this policy allows badges from notifications intercepted by DND on devices that support badging.

int getVisualEffectFullScreenIntent()

Whether this policy allows full screen intents from notifications intercepted by DND.

int getVisualEffectLights()

Whether this policy allows lights from notifications intercepted by DND.

int getVisualEffectNotificationList()

Whether this policy allows notifications intercepted by DND from appearing in notification list views like the notification shade or lockscreen on devices that support those views.

int getVisualEffectPeek()

Whether this policy allows peeking from notifications intercepted by DND.

int getVisualEffectStatusBar()

Whether this policy allows notifications intercepted by DND from appearing in the status bar on devices that support status bars.

int hashCode()

Returns a hash code value for the object.

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

CONVERSATION_SENDERS_ANYONE

public static final int CONVERSATION_SENDERS_ANYONE

Used to indicate all conversations can bypass dnd.

Constant Value: 1 (0x00000001)

CONVERSATION_SENDERS_IMPORTANT

public static final int CONVERSATION_SENDERS_IMPORTANT

Used to indicate important conversations can bypass dnd.

Constant Value: 2 (0x00000002)

CONVERSATION_SENDERS_NONE

public static final int CONVERSATION_SENDERS_NONE

Used to indicate no conversations can bypass dnd.

Constant Value: 3 (0x00000003)

CONVERSATION_SENDERS_UNSET

public static final int CONVERSATION_SENDERS_UNSET

Used to indicate no preference for the type of conversations that can bypass dnd.

Constant Value: 0 (0x00000000)

PEOPLE_TYPE_ANYONE

public static final int PEOPLE_TYPE_ANYONE

Used to indicate all calls or messages can bypass dnd.

Constant Value: 1 (0x00000001)

PEOPLE_TYPE_CONTACTS

public static final int PEOPLE_TYPE_CONTACTS

Used to indicate calls or messages from contacts can bypass dnd.

Constant Value: 2 (0x00000002)

PEOPLE_TYPE_NONE

public static final int PEOPLE_TYPE_NONE

Used to indicate no calls or messages can bypass dnd.

Constant Value: 4 (0x00000004)

PEOPLE_TYPE_STARRED

public static final int PEOPLE_TYPE_STARRED

Used to indicate calls or messages from starred contacts can bypass dnd.

Constant Value: 3 (0x00000003)

PEOPLE_TYPE_UNSET

public static final int PEOPLE_TYPE_UNSET

Used to indicate no preference for the type of people that can bypass dnd for either calls or messages.

Constant Value: 0 (0x00000000)

STATE_ALLOW

public static final int STATE_ALLOW

Indicates a type of sound or visual effect is allowed to play/show when DND is active.

Constant Value: 1 (0x00000001)

STATE_DISALLOW

public static final int STATE_DISALLOW

Indicates a type of sound or visual effect is not allowed to play/show when DND is active.

Constant Value: 2 (0x00000002)

STATE_UNSET

public static final int STATE_UNSET

Indicates no preference for whether a type of sound or visual effect is or isn't allowed to play/show when DND is active. Will default to the current set policy.

Constant Value: 0 (0x00000000)

Fields

CREATOR

public static final Creator<ZenPolicy> CREATOR

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: This value may be null.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getPriorityCallSenders

public int getPriorityCallSenders ()

Callers that can bypass DND.

Returns
int PEOPLE_TYPE_UNSET, PEOPLE_TYPE_ANYONE, PEOPLE_TYPE_CONTACTS, PEOPLE_TYPE_STARRED or PEOPLE_TYPE_NONE Value is PEOPLE_TYPE_UNSET, PEOPLE_TYPE_ANYONE, PEOPLE_TYPE_CONTACTS, PEOPLE_TYPE_STARRED, or PEOPLE_TYPE_NONE

getPriorityCategoryAlarms

public int getPriorityCategoryAlarms ()

Whether this policy wants to allow notifications with category Notification#CATEGORY_ALARM to play sounds and visually appear or to intercept them when DND is active. When alarms are disallowed, the alarm stream will be muted when DND is active.

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityCategoryCalls

public int getPriorityCategoryCalls ()

Whether this policy wants to allow notifications with category Notification#CATEGORY_CALL to play sounds and visually appear or to intercept them when DND is active. Types of callers that are allowed are specified by getPriorityCallSenders().

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityCategoryConversations

public int getPriorityCategoryConversations ()

Whether this policy wants to allow conversation notifications (see NotificationChannel#getConversationId()) to play sounds and visually appear or to intercept them when DND is active.

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityCategoryEvents

public int getPriorityCategoryEvents ()

Whether this policy wants to allow notifications with category Notification#CATEGORY_EVENT to play sounds and visually appear or to intercept them when DND is active.

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityCategoryMedia

public int getPriorityCategoryMedia ()

Whether this policy wants to allow media notifications to play sounds and visually appear or to intercept them when DND is active. When media is disallowed, the media stream will be muted when DND is active.

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityCategoryMessages

public int getPriorityCategoryMessages ()

Whether this policy wants to allow notifications with category Notification#CATEGORY_MESSAGE to play sounds and visually appear or to intercept them when DND is active. Types of message senders that are allowed are specified by getPriorityMessageSenders().

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityCategoryReminders

public int getPriorityCategoryReminders ()

Whether this policy wants to allow notifications with category Notification#CATEGORY_REMINDER to play sounds and visually appear or to intercept them when DND is active.

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityCategoryRepeatCallers

public int getPriorityCategoryRepeatCallers ()

Whether this policy wants to allow repeat callers (notifications with category Notification#CATEGORY_CALL that have recently called) to play sounds and visually appear or to intercept them when DND is active.

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityCategorySystem

public int getPriorityCategorySystem ()

Whether this policy wants to allow system sounds when DND is active. When system is STATE_DISALLOW, the system stream will be muted when DND is active.

Returns
int STATE_UNSET, STATE_ALLOW or STATE_DISALLOW Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getPriorityConversationSenders

public int getPriorityConversationSenders ()

Conversation type that can bypass DND.

Returns
int CONVERSATION_SENDERS_UNSET, CONVERSATION_SENDERS_ANYONE, CONVERSATION_SENDERS_IMPORTANT, CONVERSATION_SENDERS_NONE. Value is PEOPLE_TYPE_UNSET, PEOPLE_TYPE_ANYONE, PEOPLE_TYPE_CONTACTS, PEOPLE_TYPE_STARRED, or PEOPLE_TYPE_NONE

getPriorityMessageSenders

public int getPriorityMessageSenders ()

Message senders that can bypass DND.

Returns
int PEOPLE_TYPE_UNSET, PEOPLE_TYPE_ANYONE, PEOPLE_TYPE_CONTACTS, PEOPLE_TYPE_STARRED or PEOPLE_TYPE_NONE Value is PEOPLE_TYPE_UNSET, PEOPLE_TYPE_ANYONE, PEOPLE_TYPE_CONTACTS, PEOPLE_TYPE_STARRED, or PEOPLE_TYPE_NONE

getVisualEffectAmbient

public int getVisualEffectAmbient ()

Whether this policy allows notifications intercepted by DND from appearing on ambient displays on devices that support ambient display.

Returns
int Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getVisualEffectBadge

public int getVisualEffectBadge ()

Whether this policy allows badges from notifications intercepted by DND on devices that support badging.

Returns
int Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getVisualEffectFullScreenIntent

public int getVisualEffectFullScreenIntent ()

Whether this policy allows full screen intents from notifications intercepted by DND.

Returns
int Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getVisualEffectLights

public int getVisualEffectLights ()

Whether this policy allows lights from notifications intercepted by DND.

Returns
int Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getVisualEffectNotificationList

public int getVisualEffectNotificationList ()

Whether this policy allows notifications intercepted by DND from appearing in notification list views like the notification shade or lockscreen on devices that support those views.

Returns
int Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getVisualEffectPeek

public int getVisualEffectPeek ()

Whether this policy allows peeking from notifications intercepted by DND.

Returns
int Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

getVisualEffectStatusBar

public int getVisualEffectStatusBar ()

Whether this policy allows notifications intercepted by DND from appearing in the status bar on devices that support status bars.

Returns
int Value is STATE_UNSET, STATE_ALLOW, or STATE_DISALLOW

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.

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
Get news & tips
Blog Support

Except as noted, this content is licensed under Apache 2.0. For details and restrictions, see the Content License.

Android 7.0 r1 —

About Android Auto TV Wear Legal