ZenDeviceEffects


public final class ZenDeviceEffects
extends Object implements Parcelable

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


Represents the set of device effects (affecting display and device behavior in general) that are applied whenever an AutomaticZenRule is active.

Summary

Nested classes

class ZenDeviceEffects.Builder

Builder class for ZenDeviceEffects objects. 

Inherited constants

Fields

public static final Creator<ZenDeviceEffects> CREATOR

Parcelable.Creator that instantiates ZenDeviceEffects objects.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

int hashCode()

Returns a hash code value for the object.

boolean shouldDimWallpaper()

Whether the wallpaper should be dimmed while the rule is active.

boolean shouldDisplayGrayscale()

Whether the level of color saturation of the display should be set to minimum, effectively switching it to grayscale, while the rule is active.

boolean shouldSuppressAmbientDisplay()

Whether the ambient (always-on) display feature should be disabled while the rule is active.

boolean shouldUseNightMode()

Whether night mode (aka dark theme) should be applied while the rule is active.

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

CREATOR

Added in API level 35
public static final Creator<ZenDeviceEffects> CREATOR

Parcelable.Creator that instantiates ZenDeviceEffects objects.

Public methods

describeContents

Added in API level 35
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

Added in API level 35
public boolean equals (Object obj)

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.

Parameters
obj 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 35
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.

Returns
int a hash code value for this object.

shouldDimWallpaper

Added in API level 35
public boolean shouldDimWallpaper ()

Whether the wallpaper should be dimmed while the rule is active.

Returns
boolean

shouldDisplayGrayscale

Added in API level 35
public boolean shouldDisplayGrayscale ()

Whether the level of color saturation of the display should be set to minimum, effectively switching it to grayscale, while the rule is active.

Returns
boolean

shouldSuppressAmbientDisplay

Added in API level 35
public boolean shouldSuppressAmbientDisplay ()

Whether the ambient (always-on) display feature should be disabled while the rule is active. This will have no effect if the device doesn't support always-on display or if it's not generally enabled.

Returns
boolean

shouldUseNightMode

Added in API level 35
public boolean shouldUseNightMode ()

Whether night mode (aka dark theme) should be applied while the rule is active.

Returns
boolean

toString

Added in API level 35
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 35
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: 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