AutomaticZenRule

TYPE_BEDTIME

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

static val TYPE_DRIVING: Int

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

Value: 4

TYPE_IMMERSIVE

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

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

static val TYPE_OTHER: Int

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

Value: 0

TYPE_SCHEDULE_CALENDAR

static val TYPE_SCHEDULE_CALENDAR: Int

The type for rules triggered by calendar events.

Value: 2

TYPE_SCHEDULE_TIME

static val TYPE_SCHEDULE_TIME: Int

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

Value: 1

TYPE_THEATER

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

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

AutomaticZenRule

AutomaticZenRule(source: Parcel!)

AutomaticZenRule

AutomaticZenRule(
    name: String, 
    owner: ComponentName?, 
    configurationActivity: ComponentName?, 
    conditionId: Uri, 
    policy: ZenPolicy?, 
    interruptionFilter: Int, 
    enabled: Boolean)

Creates an automatic zen rule.

Note: Prefer AutomaticZenRule.Builder to construct an AutomaticZenRule.

AutomaticZenRule

AutomaticZenRule(
    name: String!, 
    owner: ComponentName!, 
    conditionId: Uri!, 
    interruptionFilter: Int, 
    enabled: Boolean)

Deprecated: Use AutomaticZenRule.Builder to construct an AutomaticZenRule.

Creates an automatic zen rule.

describeContents

fun describeContents(): Int

equals

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.

getConditionId

fun getConditionId(): Uri!

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

getConfigurationActivity

fun getConfigurationActivity(): ComponentName?

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

getCreationTime

fun getCreationTime(): Long

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

getDeviceEffects

fun getDeviceEffects(): ZenDeviceEffects?

Gets the ZenDeviceEffects of this rule.

getIconResId

fun getIconResId(): Int

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

getInterruptionFilter

fun getInterruptionFilter(): Int

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

getName

fun getName(): String!

Returns the name of this rule.

getOwner

fun getOwner(): ComponentName!

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

getTriggerDescription

fun getTriggerDescription(): String?

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

getType

fun getType(): Int

Gets the type of the rule.

getZenPolicy

fun getZenPolicy(): ZenPolicy?

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

hashCode

fun hashCode(): Int

isEnabled

fun isEnabled(): Boolean

Returns whether this rule is enabled.

isManualInvocationAllowed

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

fun setConditionId(conditionId: Uri!): Unit

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

setConfigurationActivity

fun setConfigurationActivity(componentName: ComponentName?): Unit

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 android.service.notification.ConditionProviderService.

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 supplied there to determine whether the rule should be active.

setDeviceEffects

fun setDeviceEffects(deviceEffects: ZenDeviceEffects?): Unit

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.

setEnabled

fun setEnabled(enabled: Boolean): Unit

Enables this rule.

setInterruptionFilter

fun setInterruptionFilter(interruptionFilter: Int): Unit

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

setName

fun setName(name: String!): Unit

Sets the name of this rule.

setZenPolicy

fun setZenPolicy(zenPolicy: ZenPolicy?): Unit

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.

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<AutomaticZenRule!>