ZenDeviceEffects

Kotlin |Java

class ZenDeviceEffects : Parcelable

kotlin.Any
↳	android.service.notification.ZenDeviceEffects

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

Summary

Nested classes
	`Builder` Builder class for `ZenDeviceEffects` objects.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
Int	`hashCode()`
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()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ZenDeviceEffects!>	`CREATOR` `Parcelable.Creator` that instantiates `ZenDeviceEffects` objects.

Public methods

describeContents

Added in API level 35

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 35

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

hashCode

Added in API level 35

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

shouldDimWallpaper

Added in API level 35

fun shouldDimWallpaper(): Boolean

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

shouldDisplayGrayscale

Added in API level 35

fun shouldDisplayGrayscale(): Boolean

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

shouldSuppressAmbientDisplay

Added in API level 35

fun shouldSuppressAmbientDisplay(): Boolean

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.

shouldUseNightMode

Added in API level 35

fun shouldUseNightMode(): Boolean

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

toString

Added in API level 35

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 35

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 35

static val CREATOR: Parcelable.Creator<ZenDeviceEffects!>

Parcelable.Creator that instantiates ZenDeviceEffects objects.