Skip to content

Most visited

Recently visited

navigation

AutomaticZenRule

public final class AutomaticZenRule
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.AutomaticZenRule


Rule instance information for zen mode.

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<AutomaticZenRule> CREATOR

Public constructors

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

Creates an automatic zen rule.

AutomaticZenRule(Parcel source)

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.

long getCreationTime()

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

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.

int hashCode()

Returns a hash code value for the object.

boolean isEnabled()

Returns whether this rule is enabled.

void setConditionId(Uri conditionId)

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

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.

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
From interface android.os.Parcelable

Fields

CREATOR

added in API level 24
Creator<AutomaticZenRule> CREATOR

Public constructors

AutomaticZenRule

added in API level 24
AutomaticZenRule (String name, 
                ComponentName owner, 
                Uri conditionId, 
                int interruptionFilter, 
                boolean enabled)

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: A representation of the state that should cause the Condition Provider service to apply the given interruption filter.

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
AutomaticZenRule (Parcel source)

Parameters
source Parcel

Public methods

describeContents

added in API level 24
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(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.

equals

added in API level 24
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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getConditionId

added in API level 24
Uri getConditionId ()

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

Returns
Uri

getCreationTime

added in API level 24
long getCreationTime ()

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

Returns
long

getInterruptionFilter

added in API level 24
int getInterruptionFilter ()

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

Returns
int

getName

added in API level 24
String getName ()

Returns the name of this rule.

Returns
String

getOwner

added in API level 24
ComponentName getOwner ()

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

Returns
ComponentName

hashCode

added in API level 24
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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isEnabled

added in API level 24
boolean isEnabled ()

Returns whether this rule is enabled.

Returns
boolean

setConditionId

added in API level 24
void setConditionId (Uri conditionId)

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

Parameters
conditionId Uri

setEnabled

added in API level 24
void setEnabled (boolean enabled)

Enables this rule.

Parameters
enabled boolean

setInterruptionFilter

added in API level 24
void setInterruptionFilter (int interruptionFilter)

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

Parameters
interruptionFilter int: The do not disturb mode to enter when this rule is active.

Value is INTERRUPTION_FILTER_NONE, INTERRUPTION_FILTER_PRIORITY, INTERRUPTION_FILTER_ALARMS, INTERRUPTION_FILTER_ALL or INTERRUPTION_FILTER_UNKNOWN.

setName

added in API level 24
void setName (String name)

Sets the name of this rule.

Parameters
name String

toString

added in API level 24
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

added in API level 24
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.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)