Skip to content

Most visited

Recently visited

navigation

Condition

public final class Condition
extends Object implements Parcelable

java.lang.Object
   ↳ android.service.notification.Condition


The current condition of an AutomaticZenRule, provided by the ConditionProviderService that owns the rule. Used to tell the system to enter Do Not Disturb mode and request that the system exit Do Not Disturb mode.

Summary

Constants

int FLAG_RELEVANT_ALWAYS

int FLAG_RELEVANT_NOW

String SCHEME

int STATE_ERROR

int STATE_FALSE

Indicates that Do Not Disturb should be turned off.

int STATE_TRUE

Indicates that Do Not Disturb should be turned on.

int STATE_UNKNOWN

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<Condition> CREATOR

public final int flags

public final int icon

public final Uri id

The URI representing the rule being updated.

public final String line1

public final String line2

public final int state

The state of this condition.

public final String summary

A summary of what the rule encoded in id means when it is enabled.

Public constructors

Condition(Uri id, String summary, int state)

An object representing the current state of a AutomaticZenRule.

Condition(Uri id, String summary, String line1, String line2, int icon, int state, int flags)
Condition(Parcel source)

Public methods

Condition copy()
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.

int hashCode()

Returns a hash code value for the object.

static boolean isValidId(Uri id, String pkg)
static Uri.Builder newId(Context context)
static String relevanceToString(int flags)
static String stateToString(int state)
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

Constants

FLAG_RELEVANT_ALWAYS

added in API level 24
int FLAG_RELEVANT_ALWAYS

Constant Value: 2 (0x00000002)

FLAG_RELEVANT_NOW

added in API level 24
int FLAG_RELEVANT_NOW

Constant Value: 1 (0x00000001)

SCHEME

added in API level 24
String SCHEME

Constant Value: "condition"

STATE_ERROR

added in API level 24
int STATE_ERROR

Constant Value: 3 (0x00000003)

STATE_FALSE

added in API level 24
int STATE_FALSE

Indicates that Do Not Disturb should be turned off. Note that all Conditions from all ConditionProviderService providers must be off for Do Not Disturb to be turned off on the device.

Constant Value: 0 (0x00000000)

STATE_TRUE

added in API level 24
int STATE_TRUE

Indicates that Do Not Disturb should be turned on.

Constant Value: 1 (0x00000001)

STATE_UNKNOWN

added in API level 24
int STATE_UNKNOWN

Constant Value: 2 (0x00000002)

Fields

CREATOR

added in API level 24
Creator<Condition> CREATOR

flags

added in API level 24
int flags

icon

added in API level 24
int icon

id

added in API level 24
Uri id

The URI representing the rule being updated. See getConditionId().

line1

added in API level 24
String line1

line2

added in API level 24
String line2

state

added in API level 24
int state

The state of this condition. STATE_TRUE will enable Do Not Disturb mode. STATE_FALSE will turn Do Not Disturb off for this rule. Note that Do Not Disturb might still be enabled globally if other conditions are in a STATE_TRUE state.

summary

added in API level 24
String summary

A summary of what the rule encoded in id means when it is enabled. User visible if the state of the condition is STATE_TRUE.

Public constructors

Condition

added in API level 24
Condition (Uri id, 
                String summary, 
                int state)

An object representing the current state of a AutomaticZenRule.

Parameters
id Uri: the getConditionId() of the zen rule

summary String: a user visible description of the rule state.

state int

Condition

added in API level 24
Condition (Uri id, 
                String summary, 
                String line1, 
                String line2, 
                int icon, 
                int state, 
                int flags)

Parameters
id Uri

summary String

line1 String

line2 String

icon int

state int

flags int

Condition

added in API level 24
Condition (Parcel source)

Parameters
source Parcel

Public methods

copy

added in API level 24
Condition copy ()

Returns
Condition

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.

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.

isValidId

added in API level 24
boolean isValidId (Uri id, 
                String pkg)

Parameters
id Uri

pkg String

Returns
boolean

newId

added in API level 24
Uri.Builder newId (Context context)

Parameters
context Context

Returns
Uri.Builder

relevanceToString

added in API level 24
String relevanceToString (int flags)

Parameters
flags int

Returns
String

stateToString

added in API level 24
String stateToString (int state)

Parameters
state int

Returns
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!

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)