# AutomaticZenRule Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # AutomaticZenRule *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/android/app/AutomaticZenRule "View this page in Java") ``` class AutomaticZenRule : Parcelable ``` |---|--------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.app.AutomaticZenRule](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#) | Rule instance information for a zen (aka DND or Attention Management) mode. ## Summary | Nested classes || |---|-------------------------------------------------------------------------------------------------------| | | [Builder](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule.Builder)
| | Constants || |----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_BEDTIME](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_BEDTIME:kotlin.Int) The type for rules triggered by bedtime/sleeping, like time of day, or snore detection. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_DRIVING](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_DRIVING:kotlin.Int) The type for rules triggered by driving detection, like Bluetooth connections or vehicle sounds. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_IMMERSIVE](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_IMMERSIVE:kotlin.Int) The type for rules triggered by the user entering an immersive activity, like opening an app using[WindowInsetsController.hide(int)](https://developer.android.com/reference/kotlin/android/view/WindowInsetsController.html#hide(kotlin.Int)). | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_MANAGED](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_MANAGED:kotlin.Int) The type for rules created and managed by a device owner. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_OTHER](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_OTHER:kotlin.Int) Rule is of a known type, but not one of the specific types. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_SCHEDULE_CALENDAR](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_SCHEDULE_CALENDAR:kotlin.Int) The type for rules triggered by calendar events. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_SCHEDULE_TIME](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_SCHEDULE_TIME:kotlin.Int) The type for rules triggered according to a time-based schedule. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_THEATER](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_THEATER:kotlin.Int) The type for rules that have a[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)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. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_UNKNOWN](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_UNKNOWN:kotlin.Int) Rule is of an unknown type. | | Inherited constants || |---|---| | From class[Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#) |----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int)
Descriptor bit used with[describeContents()](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor.
| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int)
Flag for use with[writeToParcel](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.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)`". Some implementations may want to release resources at this point.
| || | Public constructors || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | [AutomaticZenRule](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#AutomaticZenRule(android.os.Parcel))`(`source:` `[Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#)!`)`
| | [AutomaticZenRule](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#AutomaticZenRule(kotlin.String,%20android.content.ComponentName,%20android.content.ComponentName,%20android.net.Uri,%20android.service.notification.ZenPolicy,%20kotlin.Int,%20kotlin.Boolean))`(`name:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `owner:` `[ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)?`, `configurationActivity:` `[ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)?`, `conditionId:` `[Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html#)`, `policy:` `[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)?`, `interruptionFilter:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `enabled:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Creates an automatic zen rule. | | [AutomaticZenRule](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#AutomaticZenRule(kotlin.String,%20android.content.ComponentName,%20android.net.Uri,%20kotlin.Int,%20kotlin.Boolean))`(`name:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `owner:` `[ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)!`, `conditionId:` `[Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html#)!`, `interruptionFilter:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `enabled:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Creates an automatic zen rule. | | Public methods || |-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [describeContents](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#describeContents())`()`
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one. | | [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html#)! | [getConditionId](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getConditionId())`()` Returns the representation of the state that causes this rule to become active. | | [ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)? | [getConfigurationActivity](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getConfigurationActivity())`()` Returns the[ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)of the activity that shows configuration options for this rule. | | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | [getCreationTime](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getCreationTime())`()` Returns the time this rule was created, represented as milliseconds since the epoch. | | [ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#)? | [getDeviceEffects](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getDeviceEffects())`()` Gets the[ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#)of this rule. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getIconResId](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getIconResId())`()` Gets the resource id of the drawable icon for this rule. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getInterruptionFilter](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getInterruptionFilter())`()` Returns the interruption filter that is applied when this rule is active. | | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getName](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getName())`()` Returns the name of this rule. | | [ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)! | [getOwner](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getOwner())`()` Returns the[ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)of the condition provider service that owns this rule. | | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | [getTriggerDescription](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getTriggerDescription())`()` Gets the user visible description of when this rule is active (see[Condition.STATE_TRUE](https://developer.android.com/reference/kotlin/android/service/notification/Condition.html#STATE_TRUE:kotlin.Int)). | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getType](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getType())`()` Gets the type of the rule. | | [ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)? | [getZenPolicy](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getZenPolicy())`()` Gets the[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)applied if[getInterruptionFilter()](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getInterruptionFilter())is[NotificationManager.INTERRUPTION_FILTER_PRIORITY](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_PRIORITY:kotlin.Int). | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#hashCode())`()`
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isEnabled](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#isEnabled())`()` Returns whether this rule is enabled. | | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isManualInvocationAllowed](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#isManualInvocationAllowed())`()` Gets whether this rule can be manually activated by the user even when the triggering condition for the rule is not met. | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setConditionId](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#setConditionId(android.net.Uri))`(`conditionId:` `[Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html#)!`)` Sets the representation of the state that causes this rule to become active. | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setConfigurationActivity](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#setConfigurationActivity(android.content.ComponentName))`(`componentName:` `[ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)?`)` Sets the configuration activity - an activity that handles[NotificationManager.ACTION_AUTOMATIC_ZEN_RULE](https://developer.android.com/reference/kotlin/android/app/NotificationManager#ACTION_AUTOMATIC_ZEN_RULE:kotlin.String)that shows the user more information about this rule and/or allows them to configure it. | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setDeviceEffects](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#setDeviceEffects(android.service.notification.ZenDeviceEffects))`(`deviceEffects:` `[ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#)?`)` Sets the[ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#)associated to this rule. | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setEnabled](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#setEnabled(kotlin.Boolean))`(`enabled:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Enables this rule. | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setInterruptionFilter](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#setInterruptionFilter(kotlin.Int))`(`interruptionFilter:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the interruption filter that is applied when this rule is active. | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setName](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#setName(kotlin.String))`(`name:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Sets the name of this rule. | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setZenPolicy](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#setZenPolicy(android.service.notification.ZenPolicy))`(`zenPolicy:` `[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)?`)` Sets the[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)applied if[getInterruptionFilter()](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getInterruptionFilter())is[NotificationManager.INTERRUPTION_FILTER_PRIORITY](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_PRIORITY:kotlin.Int). | | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [toString](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#toString())`()`
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [writeToParcel](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#writeToParcel(android.os.Parcel,%20kotlin.Int))`(`dest:` `[Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#)`, `flags:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
| | Properties || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| | static[Parcelable.Creator](https://developer.android.com/reference/kotlin/android/os/Parcelable.Creator.html#)\<[AutomaticZenRule](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#)!\> | [CREATOR](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#CREATOR:android.os.Parcelable.Creator)
| ## Constants ### TYPE_BEDTIME Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_BEDTIME: Int ``` 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. Value: 3 ### TYPE_DRIVING Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_DRIVING: Int ``` The type for rules triggered by driving detection, like Bluetooth connections or vehicle sounds. Value: 4 ### TYPE_IMMERSIVE Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_IMMERSIVE: Int ``` The type for rules triggered by the user entering an immersive activity, like opening an app using[WindowInsetsController.hide(int)](https://developer.android.com/reference/kotlin/android/view/WindowInsetsController.html#hide(kotlin.Int)). Value: 5 ### TYPE_MANAGED Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_MANAGED: Int ``` 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. Value: 7 ### TYPE_OTHER Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_OTHER: Int ``` Rule is of a known type, but not one of the specific types. Value: 0 ### TYPE_SCHEDULE_CALENDAR Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_SCHEDULE_CALENDAR: Int ``` The type for rules triggered by calendar events. Value: 2 ### TYPE_SCHEDULE_TIME Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_SCHEDULE_TIME: Int ``` The type for rules triggered according to a time-based schedule. Value: 1 ### TYPE_THEATER Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_THEATER: Int ``` The type for rules that have a[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)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. Value: 6 ### TYPE_UNKNOWN Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_UNKNOWN: Int ``` 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. Value: -1 ## Public constructors ### AutomaticZenRule Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` AutomaticZenRule(source: Parcel!) ``` ### AutomaticZenRule Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` AutomaticZenRule(     name: String,     owner: ComponentName?,     configurationActivity: ComponentName?,     conditionId: Uri,     policy: ZenPolicy?,     interruptionFilter: Int,     enabled: Boolean) ``` Creates an automatic zen rule. Note: Prefer[AutomaticZenRule.Builder](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule.Builder)to construct an[AutomaticZenRule](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#). | Parameters || |-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `name` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html):The name of the rule. This value cannot be`null`. | | `owner` | [ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)?:The Condition Provider service that owns this rule. This can be null if you're using[NotificationManager.setAutomaticZenRuleState(String, Condition)](https://developer.android.com/reference/kotlin/android/app/NotificationManager#setAutomaticZenRuleState(kotlin.String,%20android.service.notification.Condition))instead of[android.service.notification.ConditionProviderService](https://developer.android.com/reference/kotlin/android/service/notification/ConditionProviderService.html#). | | `configurationActivity` | [ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)?:An activity that handles[NotificationManager.ACTION_AUTOMATIC_ZEN_RULE](https://developer.android.com/reference/kotlin/android/app/NotificationManager#ACTION_AUTOMATIC_ZEN_RULE:kotlin.String)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[android.service.notification.ConditionProviderService](https://developer.android.com/reference/kotlin/android/service/notification/ConditionProviderService.html#). If you are, it overrides the information specified in your manifest. This value may be`null`. | | `conditionId` | [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html#):A representation of the state that should cause your app to apply the given interruption filter. This value cannot be`null`. | | `interruptionFilter` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound \& vibration) while this rule is active. | | `policy` | [ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)?: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](https://developer.android.com/reference/kotlin/android/service/notification/Condition.html#STATE_TRUE:kotlin.Int)). This value may be`null`. | | `enabled` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):Whether the rule is enabled. | ### AutomaticZenRule Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` AutomaticZenRule(     name: String!,     owner: ComponentName!,     conditionId: Uri!,     interruptionFilter: Int,     enabled: Boolean) ``` **Deprecated:** *Use[AutomaticZenRule.Builder](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule.Builder)to construct an[AutomaticZenRule](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#).* Creates an automatic zen rule. | Parameters || |----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `name` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:The name of the rule. | | `owner` | [ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)!:The Condition Provider service that owns this rule. | | `interruptionFilter` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound \& vibration) while this rule is active. | | `enabled` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):Whether the rule is enabled. | ## Public methods ### describeContents Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun describeContents(): Int ``` | Return || |----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int) | ### equals Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun equals(other: Any?): Boolean ``` 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 || |-------|---------------------------------------------| | `obj` | the reference object with which to compare. | | `o` | This value may be`null`. | | Return || |------------------------------------------------------------------------------------|------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. | ### getConditionId Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getConditionId(): Uri! ``` Returns the representation of the state that causes this rule to become active. ### getConfigurationActivity Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getConfigurationActivity(): ComponentName? ``` Returns the[ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)of the activity that shows configuration options for this rule. | Return || |------------------------------------------------------------------------------------------------------|--------------------------| | [ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)? | This value may be`null`. | ### getCreationTime Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getCreationTime(): Long ``` Returns the time this rule was created, represented as milliseconds since the epoch. ### getDeviceEffects Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getDeviceEffects(): ZenDeviceEffects? ``` Gets the[ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#)of this rule. | Return || |-------------------------------------------------------------------------------------------------------------------------|--------------------------| | [ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#)? | This value may be`null`. | ### getIconResId Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getIconResId(): Int ``` Gets the resource id of the drawable icon for this rule. ### getInterruptionFilter Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getInterruptionFilter(): Int ``` Returns the interruption filter that is applied when this rule is active. ### getName Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getName(): String! ``` Returns the name of this rule. ### getOwner Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getOwner(): ComponentName! ``` Returns the[ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)of the condition provider service that owns this rule. ### getTriggerDescription Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getTriggerDescription(): String? ``` Gets the user visible description of when this rule is active (see[Condition.STATE_TRUE](https://developer.android.com/reference/kotlin/android/service/notification/Condition.html#STATE_TRUE:kotlin.Int)). | Return || |-----------------------------------------------------------------------------------|--------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | This value may be`null`. | ### getType Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getType(): Int ``` Gets the type of the rule. | Return || |----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | Value is[android.app.AutomaticZenRule#TYPE_UNKNOWN](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_UNKNOWN:kotlin.Int),[android.app.AutomaticZenRule#TYPE_OTHER](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_OTHER:kotlin.Int),[android.app.AutomaticZenRule#TYPE_SCHEDULE_TIME](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_SCHEDULE_TIME:kotlin.Int),[android.app.AutomaticZenRule#TYPE_SCHEDULE_CALENDAR](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_SCHEDULE_CALENDAR:kotlin.Int),[android.app.AutomaticZenRule#TYPE_BEDTIME](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_BEDTIME:kotlin.Int),[android.app.AutomaticZenRule#TYPE_DRIVING](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_DRIVING:kotlin.Int),[android.app.AutomaticZenRule#TYPE_IMMERSIVE](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_IMMERSIVE:kotlin.Int),[android.app.AutomaticZenRule#TYPE_THEATER](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_THEATER:kotlin.Int), or[android.app.AutomaticZenRule#TYPE_MANAGED](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#TYPE_MANAGED:kotlin.Int) | ### getZenPolicy Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getZenPolicy(): ZenPolicy? ``` Gets the[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)applied if[getInterruptionFilter()](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getInterruptionFilter())is[NotificationManager.INTERRUPTION_FILTER_PRIORITY](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_PRIORITY:kotlin.Int). | Return || |-----------------------------------------------------------------------------------------------------------|--------------------------| | [ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)? | This value may be`null`. | ### hashCode Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun hashCode(): Int ``` | Return || |----------------------------------------------------------------------------|------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. | ### isEnabled Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun isEnabled(): Boolean ``` Returns whether this rule is enabled. ### isManualInvocationAllowed Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun isManualInvocationAllowed(): Boolean ``` Gets whether this rule can be manually activated by the user even when the triggering condition for the rule is not met. ### setConditionId Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setConditionId(conditionId: Uri!): Unit ``` Sets the representation of the state that causes this rule to become active. ### setConfigurationActivity Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setConfigurationActivity(componentName: ComponentName?): Unit ``` Sets the configuration activity - an activity that handles[NotificationManager.ACTION_AUTOMATIC_ZEN_RULE](https://developer.android.com/reference/kotlin/android/app/NotificationManager#ACTION_AUTOMATIC_ZEN_RULE:kotlin.String)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[android.service.notification.ConditionProviderService](https://developer.android.com/reference/kotlin/android/service/notification/ConditionProviderService.html#). This is exclusive with the`owner`supplied in the constructor; rules where a configuration activity is set will not use the[android.service.notification.ConditionProviderService](https://developer.android.com/reference/kotlin/android/service/notification/ConditionProviderService.html#)supplied there to determine whether the rule should be active. | Parameters || |-----------------|-------------------------------------------------------------------------------------------------------------------------------| | `componentName` | [ComponentName](https://developer.android.com/reference/kotlin/android/content/ComponentName.html#)?:This value may be`null`. | ### setDeviceEffects Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setDeviceEffects(deviceEffects: ZenDeviceEffects?): Unit ``` Sets the[ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#)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](https://developer.android.com/reference/kotlin/android/app/NotificationManager#updateAutomaticZenRule(kotlin.String,%20android.app.AutomaticZenRule)), a`null`value here means the previous set of effects is retained. | Parameters || |-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | `deviceEffects` | [ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#)?:This value may be`null`. | ### setEnabled Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setEnabled(enabled: Boolean): Unit ``` Enables this rule. ### setInterruptionFilter Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setInterruptionFilter(interruptionFilter: Int): Unit ``` Sets the interruption filter that is applied when this rule is active. - When[NotificationManager.INTERRUPTION_FILTER_PRIORITY](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_PRIORITY:kotlin.Int), the rule will use the[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)supplied to[setZenPolicy](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#setZenPolicy(android.service.notification.ZenPolicy))(or a default one). - When[NotificationManager.INTERRUPTION_FILTER_ALARMS](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_ALARMS:kotlin.Int)or[NotificationManager.INTERRUPTION_FILTER_NONE](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_NONE:kotlin.Int), the rule will use a fixed[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)matching the filter. - When[NotificationManager.INTERRUPTION_FILTER_ALL](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_ALL:kotlin.Int), the rule will not block notifications, but can still have[ZenDeviceEffects](https://developer.android.com/reference/kotlin/android/service/notification/ZenDeviceEffects.html#).
| Parameters || |----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `interruptionFilter` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The do not disturb mode to enter when this rule is active. Value is[android.app.NotificationManager#INTERRUPTION_FILTER_NONE](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_NONE:kotlin.Int),[android.app.NotificationManager#INTERRUPTION_FILTER_PRIORITY](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_PRIORITY:kotlin.Int),[android.app.NotificationManager#INTERRUPTION_FILTER_ALARMS](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_ALARMS:kotlin.Int),[android.app.NotificationManager#INTERRUPTION_FILTER_ALL](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_ALL:kotlin.Int), or[android.app.NotificationManager#INTERRUPTION_FILTER_UNKNOWN](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_UNKNOWN:kotlin.Int) | ### setName Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setName(name: String!): Unit ``` Sets the name of this rule. ### setZenPolicy Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun setZenPolicy(zenPolicy: ZenPolicy?): Unit ``` Sets the[ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)applied if[getInterruptionFilter()](https://developer.android.com/reference/kotlin/android/app/AutomaticZenRule#getInterruptionFilter())is[NotificationManager.INTERRUPTION_FILTER_PRIORITY](https://developer.android.com/reference/kotlin/android/app/NotificationManager#INTERRUPTION_FILTER_PRIORITY:kotlin.Int). When updating an existing rule via[NotificationManager.updateAutomaticZenRule](https://developer.android.com/reference/kotlin/android/app/NotificationManager#updateAutomaticZenRule(kotlin.String,%20android.app.AutomaticZenRule)), a`null`value here means the previous policy is retained. | Parameters || |-------------|------------------------------------------------------------------------------------------------------------------------------------| | `zenPolicy` | [ZenPolicy](https://developer.android.com/reference/kotlin/android/service/notification/ZenPolicy.html#)?:This value may be`null`. | ### toString Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun toString(): String ``` | Return || |----------------------------------------------------------------------------------|----------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. | ### writeToParcel Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun writeToParcel(     dest: Parcel,     flags: Int ): Unit ``` | Parameters || |---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `dest` | [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#):The Parcel in which the object should be written. This value cannot be`null`. | | `flags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):Additional flags about how the object should be written. May be 0 or[PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int). Value is either`0`or a combination of[android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | ## Properties ### CREATOR Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val CREATOR: Parcelable.Creator ```