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 |
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
|
int
|
getPriorityCategoryCalls()
Whether this policy wants to allow notifications with category
|
int
|
getPriorityCategoryConversations()
Whether this policy wants to allow conversation notifications
(see |
int
|
getPriorityCategoryEvents()
Whether this policy wants to allow notifications with category
|
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
|
int
|
getPriorityCategoryReminders()
Whether this policy wants to allow notifications with category
|
int
|
getPriorityCategoryRepeatCallers()
Whether this policy wants to allow repeat callers (notifications with category
|
int
|
getPriorityCategorySystem()
Whether this policy wants to allow system sounds when DND is active. |
int
|
getPriorityChannelsAllowed()
Whether this policy allows |
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 |
int
|
getVisualEffectFullScreenIntent()
Whether this policy allows |
int
|
getVisualEffectLights()
Whether this policy allows |
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
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.
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 |
getPriorityChannelsAllowed
public int getPriorityChannelsAllowed ()
Whether this policy allows channels
marked as
NotificationChannel#canBypassDnd()
to bypass DND. If STATE_ALLOW
, these
channels may bypass; if STATE_DISALLOW
, then even notifications from channels
with NotificationChannel#canBypassDnd()
will be intercepted.
Returns | |
---|---|
int |
Value is STATE_UNSET , STATE_ALLOW , or STATE_DISALLOW |
getPriorityConversationSenders
public int getPriorityConversationSenders ()
Conversation type that can bypass DND.
getPriorityMessageSenders
public int getPriorityMessageSenders ()
Message senders that can bypass DND.
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 inequals
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
method, then calling thehashCode
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
method, then calling thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
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.
This value cannot be null . |
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-06-18 UTC.