NotificationChannelGroup

Kotlin |Java

class NotificationChannelGroup : Parcelable

kotlin.Any
↳	android.app.NotificationChannelGroup

A grouping of related notification channels. e.g., channels that all belong to a single account.

Summary

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 constructors
`NotificationChannelGroup(id: String!, name: CharSequence!)` Creates a notification channel group.

Public methods
NotificationChannelGroup!	`clone()`
Int	`describeContents()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
MutableList<NotificationChannel!>!	`getChannels()` Returns the list of channels that belong to this group
String!	`getDescription()` Returns the user visible description of this group.
String!	`getId()` Returns the id of this group.
CharSequence!	`getName()` Returns the user visible name of this group.
Int	`hashCode()`
Boolean	`isBlocked()` Returns whether or not notifications posted to `channels` belonging to this group are blocked.
Unit	`setDescription(description: String!)` Sets the user visible description of this group.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<NotificationChannelGroup!>	`CREATOR`

Public constructors

NotificationChannelGroup

Added in API level 26

NotificationChannelGroup(
    id: String!, 
    name: CharSequence!)

Creates a notification channel group.

Parameters
`id`	String!: The id of the group. Must be unique per package. the value may be truncated if it is too long.
`name`	CharSequence!: The user visible name of the group. You can rename this group when the system locale changes by listening for the `Intent.ACTION_LOCALE_CHANGED` broadcast. The recommended maximum length is 40 characters; the value may be truncated if it is too long.

Public methods

clone

Added in API level 26

fun clone(): NotificationChannelGroup!

Return
`NotificationChannelGroup!`	a clone of this instance.

Exceptions
`java.lang.CloneNotSupportedException`	if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

describeContents

Added in API level 26

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 26

fun equals(other: Any?): Boolean

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`	the reference object with which to compare.
`o`	This value may be `null`.

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

getChannels

Added in API level 26

fun getChannels(): MutableList<NotificationChannel!>!

Returns the list of channels that belong to this group

getDescription

Added in API level 28

fun getDescription(): String!

Returns the user visible description of this group.

getId

Added in API level 26

fun getId(): String!

Returns the id of this group.

getName

Added in API level 26

fun getName(): CharSequence!

Returns the user visible name of this group.

hashCode

Added in API level 26

fun hashCode(): Int

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

isBlocked

Added in API level 28

fun isBlocked(): Boolean

Returns whether or not notifications posted to channels belonging to this group are blocked. This value is independent of NotificationManager.areNotificationsEnabled() and NotificationChannel.getImportance().

setDescription

Added in API level 28

fun setDescription(description: String!): Unit

Sets the user visible description of this group.

The recommended maximum length is 300 characters; the value may be truncated if it is too long.

toString

Added in API level 26

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 26

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

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_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 26

static val CREATOR: Parcelable.Creator<NotificationChannelGroup!>