Added in API level 24

Summary: Nested Classes | Constants | Inherited Constants | Fields | Ctors | Methods | Inherited Methods

AutomaticZenRule

---

Kotlin |Java

public final class AutomaticZenRule
extends Object implements Parcelable

java.lang.Object
↳	android.app.AutomaticZenRule

---

Rule instance information for a zen (aka DND or Attention Management) mode.

Summary

Nested classes
class	AutomaticZenRule.Builder

Constants
int	TYPE_BEDTIME The type for rules triggered by bedtime/sleeping, like time of day, or snore detection.
int	TYPE_DRIVING The type for rules triggered by driving detection, like Bluetooth connections or vehicle sounds.
int	TYPE_IMMERSIVE The type for rules triggered by the user entering an immersive activity, like opening an app using WindowInsetsController.hide(int).
int	TYPE_MANAGED The type for rules created and managed by a device owner.
int	TYPE_OTHER Rule is of a known type, but not one of the specific types.
int	TYPE_SCHEDULE_CALENDAR The type for rules triggered by calendar events.
int	TYPE_SCHEDULE_TIME The type for rules triggered according to a time-based schedule.
int	TYPE_THEATER The type for rules that have a ZenPolicy that implies that the device should not make sound and potentially hide some visual effects; may be triggered when entering a location where silence is requested, like a theater.
int	TYPE_UNKNOWN Rule is of an unknown type.

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<AutomaticZenRule>	CREATOR

Public constructors
AutomaticZenRule(Parcel source)
AutomaticZenRule(String name, ComponentName owner, ComponentName configurationActivity, Uri conditionId, ZenPolicy policy, int interruptionFilter, boolean enabled) Creates an automatic zen rule.
AutomaticZenRule(String name, ComponentName owner, Uri conditionId, int interruptionFilter, boolean enabled) This constructor is deprecated. Use AutomaticZenRule.Builder to construct an AutomaticZenRule.

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.
Uri	getConditionId() Returns the representation of the state that causes this rule to become active.
ComponentName	getConfigurationActivity() Returns the ComponentName of the activity that shows configuration options for this rule.
long	getCreationTime() Returns the time this rule was created, represented as milliseconds since the epoch.
ZenDeviceEffects	getDeviceEffects() Gets the ZenDeviceEffects of this rule.
int	getIconResId() Gets the resource id of the drawable icon for this rule.
int	getInterruptionFilter() Returns the interruption filter that is applied when this rule is active.
String	getName() Returns the name of this rule.
ComponentName	getOwner() Returns the ComponentName of the condition provider service that owns this rule.
String	getTriggerDescription() Gets the user visible description of when this rule is active (see Condition.STATE_TRUE).
int	getType() Gets the type of the rule.
ZenPolicy	getZenPolicy() Gets the ZenPolicy applied if getInterruptionFilter() is NotificationManager.INTERRUPTION_FILTER_PRIORITY.
int	hashCode() Returns a hash code value for the object.
boolean	isEnabled() Returns whether this rule is enabled.
boolean	isManualInvocationAllowed() Gets whether this rule can be manually activated by the user even when the triggering condition for the rule is not met.
void	setConditionId(Uri conditionId) Sets the representation of the state that causes this rule to become active.
void	setConfigurationActivity(ComponentName componentName) Sets the configuration activity - an activity that handles NotificationManager.ACTION_AUTOMATIC_ZEN_RULE that shows the user more information about this rule and/or allows them to configure it.
void	setDeviceEffects(ZenDeviceEffects deviceEffects) Sets the ZenDeviceEffects associated to this rule.
void	setEnabled(boolean enabled) Enables this rule.
void	setInterruptionFilter(int interruptionFilter) Sets the interruption filter that is applied when this rule is active.
void	setName(String name) Sets the name of this rule.
void	setZenPolicy(ZenPolicy zenPolicy) Sets the ZenPolicy applied if getInterruptionFilter() is NotificationManager.INTERRUPTION_FILTER_PRIORITY.
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 Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

TYPE_BEDTIME

Added in API level 35

public static final int TYPE_BEDTIME

The type for rules triggered by bedtime/sleeping, like time of day, or snore detection.

Only the 'Wellbeing' app may own rules of this type.

Constant Value: 3 (0x00000003)

TYPE_DRIVING

Added in API level 35

public static final int TYPE_DRIVING

The type for rules triggered by driving detection, like Bluetooth connections or vehicle sounds.

Constant Value: 4 (0x00000004)

TYPE_IMMERSIVE

Added in API level 35

public static final int TYPE_IMMERSIVE

The type for rules triggered by the user entering an immersive activity, like opening an app using WindowInsetsController.hide(int).

Constant Value: 5 (0x00000005)

TYPE_MANAGED

Added in API level 35

public static final int TYPE_MANAGED

The type for rules created and managed by a device owner. These rules may not be fully editable by the device user.

Only a 'Device Owner' app may own rules of this type.

Constant Value: 7 (0x00000007)

TYPE_OTHER

Added in API level 35

public static final int TYPE_OTHER

Rule is of a known type, but not one of the specific types.

Constant Value: 0 (0x00000000)

TYPE_SCHEDULE_CALENDAR

Added in API level 35

public static final int TYPE_SCHEDULE_CALENDAR

The type for rules triggered by calendar events.

Constant Value: 2 (0x00000002)

TYPE_SCHEDULE_TIME

Added in API level 35

public static final int TYPE_SCHEDULE_TIME

The type for rules triggered according to a time-based schedule.

Constant Value: 1 (0x00000001)

TYPE_THEATER

Added in API level 35

public static final int TYPE_THEATER

The type for rules that have a ZenPolicy that implies that the device should not make sound and potentially hide some visual effects; may be triggered when entering a location where silence is requested, like a theater.

Constant Value: 6 (0x00000006)

TYPE_UNKNOWN

Added in API level 35

public static final int TYPE_UNKNOWN

Rule is of an unknown type. This is the default value if not provided by the owning app, and the value returned if the true type was added in an API level higher than the calling app's targetSdk.

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in API level 24

public static final Creator<AutomaticZenRule> CREATOR

Public constructors

AutomaticZenRule

Added in API level 24

public AutomaticZenRule (Parcel source)

Parameters
source	Parcel

AutomaticZenRule

Added in API level 29

public AutomaticZenRule (String name, 
                ComponentName owner, 
                ComponentName configurationActivity, 
                Uri conditionId, 
                ZenPolicy policy, 
                int interruptionFilter, 
                boolean enabled)

Creates an automatic zen rule.

Note: Prefer AutomaticZenRule.Builder to construct an AutomaticZenRule.

Parameters
name	String: The name of the rule. This value cannot be null.
owner	ComponentName: The Condition Provider service that owns this rule. This can be null if you're using NotificationManager.setAutomaticZenRuleState(String, Condition) instead of ConditionProviderService.
configurationActivity	ComponentName: An activity that handles NotificationManager.ACTION_AUTOMATIC_ZEN_RULE that shows the user more information about this rule and/or allows them to configure it. This is required if you are not using a ConditionProviderService. If you are, it overrides the information specified in your manifest. This value may be null.
conditionId	Uri: A representation of the state that should cause your app to apply the given interruption filter. This value cannot be null.
policy	ZenPolicy: The policy defines which notifications are allowed to interrupt the user while this rule is active. This overrides the global policy while this rule is action (Condition.STATE_TRUE). This value may be null.
interruptionFilter	int: The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound & vibration) while this rule is active.
enabled	boolean: Whether the rule is enabled.

AutomaticZenRule

Added in API level 24

public AutomaticZenRule (String name, 
                ComponentName owner, 
                Uri conditionId, 
                int interruptionFilter, 
                boolean enabled)

This constructor is deprecated.
Use AutomaticZenRule.Builder to construct an AutomaticZenRule.

Creates an automatic zen rule.

Parameters
name	String: The name of the rule.
owner	ComponentName: The Condition Provider service that owns this rule.
conditionId	Uri
interruptionFilter	int: The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound & vibration) while this rule is active.
enabled	boolean: Whether the rule is enabled.

Public methods

describeContents

Added in API level 24

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

Added in API level 24

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.

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.

getConditionId

Added in API level 24

public Uri getConditionId ()

Returns the representation of the state that causes this rule to become active.

Returns
Uri

getConfigurationActivity

Added in API level 29

public ComponentName getConfigurationActivity ()

Returns the ComponentName of the activity that shows configuration options for this rule.

Returns
ComponentName	This value may be null.

getCreationTime

Added in API level 24

public long getCreationTime ()

Returns the time this rule was created, represented as milliseconds since the epoch.

Returns
long

getDeviceEffects

Added in API level 35

public ZenDeviceEffects getDeviceEffects ()

Gets the ZenDeviceEffects of this rule.

Returns
ZenDeviceEffects	This value may be null.

getIconResId

Added in API level 35

public int getIconResId ()

Gets the resource id of the drawable icon for this rule.

Returns
int

getInterruptionFilter

Added in API level 24

public int getInterruptionFilter ()

Returns the interruption filter that is applied when this rule is active.

Returns
int

getName

Added in API level 24

public String getName ()

Returns the name of this rule.

Returns
String

getOwner

Added in API level 24

public ComponentName getOwner ()

Returns the ComponentName of the condition provider service that owns this rule.

Returns
ComponentName

getTriggerDescription

Added in API level 35

public String getTriggerDescription ()

Gets the user visible description of when this rule is active (see Condition.STATE_TRUE).

Returns
String	This value may be null.

getType

Added in API level 35

public int getType ()

Gets the type of the rule.

Returns
int	Value is TYPE_UNKNOWN, TYPE_OTHER, TYPE_SCHEDULE_TIME, TYPE_SCHEDULE_CALENDAR, TYPE_BEDTIME, TYPE_DRIVING, TYPE_IMMERSIVE, TYPE_THEATER, or TYPE_MANAGED

getZenPolicy

Added in API level 29

public ZenPolicy getZenPolicy ()

Gets the ZenPolicy applied if getInterruptionFilter() is NotificationManager.INTERRUPTION_FILTER_PRIORITY.

Returns
ZenPolicy	This value may be null.

hashCode

Added in API level 24

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

Returns
int	a hash code value for this object.

isEnabled

Added in API level 24

public boolean isEnabled ()

Returns whether this rule is enabled.

Returns
boolean

isManualInvocationAllowed

Added in API level 35

public boolean isManualInvocationAllowed ()

Gets whether this rule can be manually activated by the user even when the triggering condition for the rule is not met.

Returns
boolean

setConditionId

Added in API level 24

public void setConditionId (Uri conditionId)

Sets the representation of the state that causes this rule to become active.

Parameters
conditionId	Uri

setConfigurationActivity

Added in API level 29

public void setConfigurationActivity (ComponentName componentName)

Sets the configuration activity - an activity that handles NotificationManager.ACTION_AUTOMATIC_ZEN_RULE that shows the user more information about this rule and/or allows them to configure it. This is required to be non-null for rules that are not backed by a ConditionProviderService.

This is exclusive with the owner supplied in the constructor; rules where a configuration activity is set will not use the ConditionProviderService supplied there to determine whether the rule should be active.

Parameters
componentName	ComponentName: This value may be null.

setDeviceEffects

Added in API level 35

public void setDeviceEffects (ZenDeviceEffects deviceEffects)

Sets the ZenDeviceEffects associated to this rule. Device effects specify changes to the device behavior that should apply while the rule is active, but are not directly related to suppressing notifications (for example: disabling always-on display).

When updating an existing rule via NotificationManager.updateAutomaticZenRule, a null value here means the previous set of effects is retained.

Parameters
deviceEffects	ZenDeviceEffects: This value may be null.

setEnabled

Added in API level 24

public void setEnabled (boolean enabled)

Enables this rule.

Parameters
enabled	boolean

setInterruptionFilter

Added in API level 24

public void setInterruptionFilter (int interruptionFilter)

Sets the interruption filter that is applied when this rule is active.

• When NotificationManager.INTERRUPTION_FILTER_PRIORITY, the rule will use the ZenPolicy supplied to setZenPolicy(ZenPolicy) (or a default one).
• When NotificationManager.INTERRUPTION_FILTER_ALARMS or NotificationManager.INTERRUPTION_FILTER_NONE, the rule will use a fixed ZenPolicy matching the filter.
• When NotificationManager.INTERRUPTION_FILTER_ALL, the rule will not block notifications, but can still have ZenDeviceEffects.

Parameters
interruptionFilter	int: The do not disturb mode to enter when this rule is active. Value is NotificationManager.INTERRUPTION_FILTER_NONE, NotificationManager.INTERRUPTION_FILTER_PRIORITY, NotificationManager.INTERRUPTION_FILTER_ALARMS, NotificationManager.INTERRUPTION_FILTER_ALL, or NotificationManager.INTERRUPTION_FILTER_UNKNOWN

setName

Added in API level 24

public void setName (String name)

Sets the name of this rule.

Parameters
name	String

setZenPolicy

Added in API level 29

public void setZenPolicy (ZenPolicy zenPolicy)

Sets the ZenPolicy applied if getInterruptionFilter() is NotificationManager.INTERRUPTION_FILTER_PRIORITY.

When updating an existing rule via NotificationManager.updateAutomaticZenRule, a null value here means the previous policy is retained.

Parameters
zenPolicy	ZenPolicy: This value may be null.

toString

Added in API level 24

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 24

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