NotificationChannelGroup
public
final
class
NotificationChannelGroup
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.app.NotificationChannelGroup |
A grouping of related notification channels. e.g., channels that all belong to a single account.
Summary
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<NotificationChannelGroup> |
CREATOR
|
Public constructors | |
---|---|
NotificationChannelGroup(String id, CharSequence name)
Creates a notification channel group. |
Public methods | |
---|---|
NotificationChannelGroup
|
clone()
Creates and returns a copy of this object. |
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. |
List<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()
Returns a hash code value for the object. |
boolean
|
isBlocked()
Returns whether or not notifications posted to |
void
|
setDescription(String description)
Sets the user visible description of this group. |
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
NotificationChannelGroup
public NotificationChannelGroup (String id, CharSequence name)
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
public NotificationChannelGroup clone ()
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:
will be true, and that the expression: x.clone() != x
will be x.clone().getClass() == x.getClass()
true
, but these are not absolute requirements.
While it is typically the case that:
will be 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.
Returns | |
---|---|
NotificationChannelGroup |
a clone of this instance. |
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. |
getChannels
public List<NotificationChannel> getChannels ()
Returns the list of channels that belong to this group
Returns | |
---|---|
List<NotificationChannel> |
getDescription
public String getDescription ()
Returns the user visible description of this group.
Returns | |
---|---|
String |
getName
public CharSequence getName ()
Returns the user visible name of this group.
Returns | |
---|---|
CharSequence |
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. |
isBlocked
public boolean isBlocked ()
Returns whether or not notifications posted to channels
belonging
to this group are blocked. This value is independent of
NotificationManager.areNotificationsEnabled()
and
NotificationChannel.getImportance()
.
Returns | |
---|---|
boolean |
setDescription
public void setDescription (String description)
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.
Parameters | |
---|---|
description |
String |
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 |