NotificationChannelGroup
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 | |
|---|---|
| Public constructors | |
|---|---|
NotificationChannelGroup(id: String!, name: CharSequence!)Creates a notification channel group. |
|
| Public methods | |
|---|---|
| NotificationChannelGroup! |
clone()Creates and returns a copy of this object. |
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| MutableList<NotificationChannel!>! |
Returns the list of channels that belong to this group |
| String! |
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()Returns a hash code value for the object. |
| Boolean |
Returns whether or not notifications posted to |
| Unit |
setDescription(description: String!)Sets the user visible description of this group. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<NotificationChannelGroup!> | |
Public constructors
NotificationChannelGroup
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
fun clone(): NotificationChannelGroup!
Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:
x.clone() != x
x.clone().getClass() == x.getClass()
true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().
By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.
| 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
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons 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 | |
|---|---|
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
fun getChannels(): MutableList<NotificationChannel!>!
Returns the list of channels that belong to this group
getDescription
fun getDescription(): String!
Returns the user visible description of this group.
getName
fun getName(): CharSequence!
Returns the user visible name of this group.
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
isBlocked
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
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
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|