AutomaticZenRule

TYPE_BEDTIME

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

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

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

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

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

public static final int TYPE_SCHEDULE_CALENDAR

The type for rules triggered by calendar events.

Constant Value: 2 (0x00000002)

TYPE_SCHEDULE_TIME

public static final int TYPE_SCHEDULE_TIME

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

Constant Value: 1 (0x00000001)

TYPE_THEATER

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

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

Constant Value: -1 (0xffffffff)

CREATOR

public static final Creator<AutomaticZenRule> CREATOR

AutomaticZenRule

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.

AutomaticZenRule

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.

AutomaticZenRule

public AutomaticZenRule (Parcel source)

describeContents

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.

equals

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.

getConditionId

public Uri getConditionId ()

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

getConfigurationActivity

public ComponentName getConfigurationActivity ()

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

getCreationTime

public long getCreationTime ()

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

getDeviceEffects

public ZenDeviceEffects getDeviceEffects ()

Gets the ZenDeviceEffects of this rule.

getIconResId

public int getIconResId ()

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

getInterruptionFilter

public int getInterruptionFilter ()

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

getName

public String getName ()

Returns the name of this rule.

getOwner

public ComponentName getOwner ()

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

getTriggerDescription

public String getTriggerDescription ()

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

getType

public int getType ()

Gets the type of the rule.

getZenPolicy

public ZenPolicy getZenPolicy ()

Gets the zen policy.

hashCode

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.

isEnabled

public boolean isEnabled ()

Returns whether this rule is enabled.

isManualInvocationAllowed

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.

setConditionId

public void setConditionId (Uri conditionId)

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

setConfigurationActivity

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.

setDeviceEffects

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.

setEnabled

public void setEnabled (boolean enabled)

Enables this rule.

setInterruptionFilter

public void setInterruptionFilter (int interruptionFilter)

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

setName

public void setName (String name)

Sets the name of this rule.

setZenPolicy

public void setZenPolicy (ZenPolicy zenPolicy)

Sets the zen policy.

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

toString

public String toString ()

Returns a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.