AutomaticZenRule
public
final
class
AutomaticZenRule
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.AutomaticZenRule |
Rule instance information for a zen (aka DND or Attention Management) mode.
Summary
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<AutomaticZenRule> |
CREATOR
|
Public constructors | |
---|---|
AutomaticZenRule(String name, ComponentName owner, Uri conditionId, int interruptionFilter, boolean enabled)
This constructor is deprecated.
use |
|
AutomaticZenRule(String name, ComponentName owner, ComponentName configurationActivity, Uri conditionId, ZenPolicy policy, 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. |
ComponentName
|
getConfigurationActivity()
Returns the |
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 |
ZenPolicy
|
getZenPolicy()
Gets the zen policy. |
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
|
setConfigurationActivity(ComponentName componentName)
Sets the configuration activity - an activity that handles
|
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. |
void
|
setZenPolicy(ZenPolicy zenPolicy)
Sets the zen policy. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public constructors
AutomaticZenRule
public AutomaticZenRule (String name, ComponentName owner, Uri conditionId, int interruptionFilter, boolean enabled)
This constructor is deprecated.
use AutomaticZenRule(java.lang.String, android.content.ComponentName, android.content.ComponentName, android.net.Uri, android.service.notification.ZenPolicy, int, boolean)
.
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 |
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
public AutomaticZenRule (String name, ComponentName owner, ComponentName configurationActivity, Uri conditionId, ZenPolicy policy, int interruptionFilter, boolean enabled)
Creates an automatic zen rule.
Parameters | |
---|---|
name |
String : The name of the rule.
This value cannot be null . |
owner |
ComponentName : The Condition Provider service that owns this rule. This can be null if you're
using NotificationManager#setAutomaticZenRuleState(String, Condition)
instead of ConditionProviderService . |
configurationActivity |
ComponentName : 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 if you are not using a
ConditionProviderService .
If you are, it overrides the information specified in your
manifest.
This value may be null . |
conditionId |
Uri : A representation of the state that should cause your app to apply the
given interruption filter.
This value cannot be null . |
policy |
ZenPolicy : The policy defines which notifications are allowed to interrupt the user
while this rule is active. This overrides the global policy while this rule is
action (Condition#STATE_TRUE ).
This value may be null . |
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
public AutomaticZenRule (Parcel source)
Parameters | |
---|---|
source |
Parcel |
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. |
getConditionId
public Uri getConditionId ()
Returns the representation of the state that causes this rule to become active.
Returns | |
---|---|
Uri |
getConfigurationActivity
public ComponentName getConfigurationActivity ()
Returns the ComponentName
of the activity that shows configuration options
for this rule.
Returns | |
---|---|
ComponentName |
This value may be null . |
getCreationTime
public long getCreationTime ()
Returns the time this rule was created, represented as milliseconds since the epoch.
Returns | |
---|---|
long |
getInterruptionFilter
public int getInterruptionFilter ()
Returns the interruption filter that is applied when this rule is active.
Returns | |
---|---|
int |
getName
public String getName ()
Returns the name of this rule.
Returns | |
---|---|
String |
getOwner
public ComponentName getOwner ()
Returns the ComponentName
of the condition provider service that owns this rule.
Returns | |
---|---|
ComponentName |
getZenPolicy
public ZenPolicy getZenPolicy ()
Gets the zen policy.
Returns | |
---|---|
ZenPolicy |
This value may be null . |
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. |
isEnabled
public boolean isEnabled ()
Returns whether this rule is enabled.
Returns | |
---|---|
boolean |
setConditionId
public void setConditionId (Uri conditionId)
Sets the representation of the state that causes this rule to become active.
Parameters | |
---|---|
conditionId |
Uri |
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 ConditionProviderService
.
Parameters | |
---|---|
componentName |
ComponentName : This value may be null . |
setEnabled
public void setEnabled (boolean enabled)
Enables this rule.
Parameters | |
---|---|
enabled |
boolean |
setInterruptionFilter
public 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 NotificationManager.INTERRUPTION_FILTER_NONE , NotificationManager.INTERRUPTION_FILTER_PRIORITY , NotificationManager.INTERRUPTION_FILTER_ALARMS , NotificationManager.INTERRUPTION_FILTER_ALL , or NotificationManager.INTERRUPTION_FILTER_UNKNOWN |
setName
public void setName (String name)
Sets the name of this rule.
Parameters | |
---|---|
name |
String |
setZenPolicy
public void setZenPolicy (ZenPolicy zenPolicy)
Sets the zen policy.
Parameters | |
---|---|
zenPolicy |
ZenPolicy : This value may be null . |
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 |