ZenPolicy

Kotlin |Java

class ZenPolicy : Parcelable

kotlin.Any
↳	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
	`Builder` Builder class for `ZenPolicy` objects.

Constants
static Int	`CONVERSATION_SENDERS_ANYONE` Used to indicate all conversations can bypass dnd.
static Int	`CONVERSATION_SENDERS_IMPORTANT` Used to indicate important conversations can bypass dnd.
static Int	`CONVERSATION_SENDERS_NONE` Used to indicate no conversations can bypass dnd.
static Int	`CONVERSATION_SENDERS_UNSET` Used to indicate no preference for the type of conversations that can bypass dnd.
static Int	`PEOPLE_TYPE_ANYONE` Used to indicate all calls or messages can bypass dnd.
static Int	`PEOPLE_TYPE_CONTACTS` Used to indicate calls or messages from contacts can bypass dnd.
static Int	`PEOPLE_TYPE_NONE` Used to indicate no calls or messages can bypass dnd.
static Int	`PEOPLE_TYPE_STARRED` Used to indicate calls or messages from starred contacts can bypass dnd.
static Int	`PEOPLE_TYPE_UNSET` Used to indicate no preference for the type of people that can bypass dnd for either calls or messages.
static Int	`STATE_ALLOW` Indicates a type of sound or visual effect is allowed to play/show when DND is active.
static Int	`STATE_DISALLOW` Indicates a type of sound or visual effect is not allowed to play/show when DND is active.
static 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

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)` 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	`getPriorityChannelsAllowed()` Whether this policy allows `channels` marked as `NotificationChannel.canBypassDnd()` to bypass DND.
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()`
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<ZenPolicy!>	`CREATOR`

Constants

CONVERSATION_SENDERS_ANYONE

Added in API level 30

static val CONVERSATION_SENDERS_ANYONE: Int

Used to indicate all conversations can bypass dnd.

Value: 1

CONVERSATION_SENDERS_IMPORTANT

Added in API level 30

static val CONVERSATION_SENDERS_IMPORTANT: Int

Used to indicate important conversations can bypass dnd.

Value: 2

CONVERSATION_SENDERS_NONE

Added in API level 30

static val CONVERSATION_SENDERS_NONE: Int

Used to indicate no conversations can bypass dnd.

Value: 3

CONVERSATION_SENDERS_UNSET

Added in API level 30

static val CONVERSATION_SENDERS_UNSET: Int

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

Value: 0

Parameters
`obj`	the reference object with which to compare.
`o`	This value may be `null`.

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

ZenPolicy

Summary

Constants

CONVERSATION_SENDERS_ANYONE

CONVERSATION_SENDERS_IMPORTANT

CONVERSATION_SENDERS_NONE

CONVERSATION_SENDERS_UNSET

PEOPLE_TYPE_ANYONE

PEOPLE_TYPE_CONTACTS

PEOPLE_TYPE_NONE

PEOPLE_TYPE_STARRED

PEOPLE_TYPE_UNSET

STATE_ALLOW

STATE_DISALLOW

STATE_UNSET

Public methods

describeContents

equals

getPriorityCallSenders

getPriorityCategoryAlarms

getPriorityCategoryCalls

getPriorityCategoryConversations

getPriorityCategoryEvents

getPriorityCategoryMedia

getPriorityCategoryMessages

getPriorityCategoryReminders

getPriorityCategoryRepeatCallers

getPriorityCategorySystem

getPriorityChannelsAllowed

getPriorityConversationSenders

getPriorityMessageSenders

getVisualEffectAmbient

getVisualEffectBadge

getVisualEffectFullScreenIntent

getVisualEffectLights

getVisualEffectNotificationList

getVisualEffectPeek

getVisualEffectStatusBar

hashCode

toString

writeToParcel

Properties

CREATOR