AutomaticZenRule

Kotlin |Java

class AutomaticZenRule : Parcelable

kotlin.Any
↳	android.app.AutomaticZenRule

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

Summary

Nested classes
	`Builder`

Constants
static Int	`TYPE_BEDTIME` The type for rules triggered by bedtime/sleeping, like time of day, or snore detection.
static Int	`TYPE_DRIVING` The type for rules triggered by driving detection, like Bluetooth connections or vehicle sounds.
static Int	`TYPE_IMMERSIVE` The type for rules triggered by the user entering an immersive activity, like opening an app using `WindowInsetsController#hide(int)`.
static Int	`TYPE_MANAGED` The type for rules created and managed by a device owner.
static Int	`TYPE_OTHER` Rule is of a known type, but not one of the specific types.
static Int	`TYPE_SCHEDULE_CALENDAR` The type for rules triggered by calendar events.
static Int	`TYPE_SCHEDULE_TIME` The type for rules triggered according to a time-based schedule.
static 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.
static Int	`TYPE_UNKNOWN` Rule is of an unknown type.

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 constructors
`AutomaticZenRule(name: String!, owner: ComponentName!, conditionId: Uri!, interruptionFilter: Int, enabled: Boolean)` Creates an automatic zen rule.
`AutomaticZenRule(name: String, owner: ComponentName?, configurationActivity: ComponentName?, conditionId: Uri, policy: ZenPolicy?, interruptionFilter: Int, enabled: Boolean)` Creates an automatic zen rule.
`AutomaticZenRule(source: Parcel!)`

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)` 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 zen policy.
Int	`hashCode()`
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.
Unit	`setConditionId(conditionId: Uri!)` Sets the representation of the state that causes this rule to become active.
Unit	`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.
Unit	`setDeviceEffects(deviceEffects: ZenDeviceEffects?)` Sets the `ZenDeviceEffects` associated to this rule.
Unit	`setEnabled(enabled: Boolean)` Enables this rule.
Unit	`setInterruptionFilter(interruptionFilter: Int)` Sets the interruption filter that is applied when this rule is active.
Unit	`setName(name: String!)` Sets the name of this rule.
Unit	`setZenPolicy(zenPolicy: ZenPolicy?)` Sets the zen policy.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

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

Constants

TYPE_BEDTIME

Added in API level 35

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

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

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

Value: 5

TYPE_MANAGED

Added in API level 35

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

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

static val TYPE_SCHEDULE_CALENDAR: Int

The type for rules triggered by calendar events.

Value: 2

TYPE_SCHEDULE_TIME

Added in API level 35

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

static val TYPE_THEATER: Int

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.

Value: 6

TYPE_UNKNOWN

Added in API level 35

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 lower than the calling app's targetSdk.

Value: -1

Parameters
`name`	String!: The name of the rule.
`owner`	ComponentName!: The Condition Provider service that owns this rule.
`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.

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 `android.service.notification.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 `android.service.notification.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`.
`interruptionFilter`	Int: The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound & vibration) while this rule is active.
`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`.
`enabled`	Boolean: Whether the rule is enabled.

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

AutomaticZenRule

Summary

Constants

TYPE_BEDTIME

TYPE_DRIVING

TYPE_IMMERSIVE

TYPE_MANAGED

TYPE_OTHER

TYPE_SCHEDULE_CALENDAR

TYPE_SCHEDULE_TIME

TYPE_THEATER

TYPE_UNKNOWN

Public constructors