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
app 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 |
SOURCE_CONTEXT
The state is changing due to a change in context (such as detected driving or sleeping). |
int |
SOURCE_SCHEDULE
The state is changing due to an automatic schedule (alarm, set time, etc). |
int |
SOURCE_UNKNOWN
The state is changing due to an unknown reason. |
int |
SOURCE_USER_ACTION
The state is changing due to an explicit user action. |
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 |
---|
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 |
source
The source of, or reason for, the state change represented by this Condition. |
public
final
int |
state
The state of this condition. |
public
final
String |
summary
A summary of what the rule encoded in |
Public constructors | |
---|---|
Condition(Uri id, String summary, int state)
An object representing the current state of a |
|
Condition(Uri id, String summary, int state, int source)
An object representing the current state of a |
|
Condition(Uri id, String summary, String line1, String line2, int icon, int state, int flags)
|
|
Condition(Uri id, String summary, String line1, String line2, int icon, int state, int source, int flags)
An object representing the current state of a |
|
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 | |
---|---|
Constants
FLAG_RELEVANT_ALWAYS
public static final int FLAG_RELEVANT_ALWAYS
Constant Value: 2 (0x00000002)
FLAG_RELEVANT_NOW
public static final int FLAG_RELEVANT_NOW
Constant Value: 1 (0x00000001)
SOURCE_CONTEXT
public static final int SOURCE_CONTEXT
The state is changing due to a change in context (such as detected driving or sleeping).
Constant Value: 3 (0x00000003)
SOURCE_SCHEDULE
public static final int SOURCE_SCHEDULE
The state is changing due to an automatic schedule (alarm, set time, etc).
Constant Value: 2 (0x00000002)
SOURCE_UNKNOWN
public static final int SOURCE_UNKNOWN
The state is changing due to an unknown reason.
Constant Value: 0 (0x00000000)
SOURCE_USER_ACTION
public static final int SOURCE_USER_ACTION
The state is changing due to an explicit user action.
Constant Value: 1 (0x00000001)
STATE_ERROR
public static final int STATE_ERROR
Constant Value: 3 (0x00000003)
STATE_FALSE
public static final int STATE_FALSE
Indicates that Do Not Disturb should be turned off. Note that all Conditions from all
AutomaticZenRule
providers must be off for Do Not Disturb to be turned
off on the device.
Constant Value: 0 (0x00000000)
STATE_TRUE
public static final int STATE_TRUE
Indicates that Do Not Disturb should be turned on.
Constant Value: 1 (0x00000001)
STATE_UNKNOWN
public static final int STATE_UNKNOWN
Constant Value: 2 (0x00000002)
Fields
id
public final Uri id
The URI representing the rule being updated.
See AutomaticZenRule.getConditionId()
.
source
public final int source
The source of, or reason for, the state change represented by this Condition. *
Value is SOURCE_UNKNOWN
, SOURCE_USER_ACTION
, SOURCE_SCHEDULE
, or SOURCE_CONTEXT
state
public final 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.
Value is STATE_FALSE
, STATE_TRUE
, STATE_UNKNOWN
, or STATE_ERROR
summary
public final 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
public Condition (Uri id, String summary, int state)
An object representing the current state of a AutomaticZenRule
.
Parameters | |
---|---|
id |
Uri : the AutomaticZenRule.getConditionId() of the zen rule |
summary |
String : a user visible description of the rule state |
state |
int : whether the mode should be activated or deactivated |
Condition
public Condition (Uri id, String summary, int state, int source)
An object representing the current state of a AutomaticZenRule
.
Parameters | |
---|---|
id |
Uri : the AutomaticZenRule.getConditionId() of the zen rule
This value may be null . |
summary |
String : a user visible description of the rule state
This value may be null . |
state |
int : whether the mode should be activated or deactivated
Value is STATE_FALSE , STATE_TRUE , STATE_UNKNOWN , or STATE_ERROR |
source |
int : the source of, or reason for, the state change represented by this Condition
Value is SOURCE_UNKNOWN , SOURCE_USER_ACTION , SOURCE_SCHEDULE , or SOURCE_CONTEXT |
Condition
public 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
public Condition (Uri id, String summary, String line1, String line2, int icon, int state, int source, int flags)
An object representing the current state of a AutomaticZenRule
.
Parameters | |
---|---|
id |
Uri : the AutomaticZenRule.getConditionId() of the zen rule
This value may be null . |
summary |
String : a user visible description of the rule state
This value may be null . |
line1 |
String : a user-visible description of when the rule will end
This value may be null . |
line2 |
String : a continuation of the user-visible description of when the rule will end
This value may be null . |
icon |
int : an icon representing this condition |
state |
int : whether the mode should be activated or deactivated
Value is STATE_FALSE , STATE_TRUE , STATE_UNKNOWN , or STATE_ERROR |
source |
int : the source of, or reason for, the state change represented by this Condition
Value is SOURCE_UNKNOWN , SOURCE_USER_ACTION , SOURCE_SCHEDULE , or SOURCE_CONTEXT |
flags |
int : flags on this condition |
Public methods
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.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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.
Parameters | |
---|---|
o |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
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 inequals
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 thehashCode
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 thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
isValidId
public static boolean isValidId (Uri id, String pkg)
Parameters | |
---|---|
id |
Uri |
pkg |
String |
Returns | |
---|---|
boolean |
newId
public static Uri.Builder newId (Context context)
Parameters | |
---|---|
context |
Context |
Returns | |
---|---|
Uri.Builder |
relevanceToString
public static String relevanceToString (int flags)
Parameters | |
---|---|
flags |
int |
Returns | |
---|---|
String |
stateToString
public static String stateToString (int state)
Parameters | |
---|---|
state |
int |
Returns | |
---|---|
String |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public 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.
This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |