NotificationChannel

public final class NotificationChannel
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.NotificationChannel


A representation of settings that apply to a collection of similarly themed notifications.

Summary

Constants

String DEFAULT_CHANNEL_ID

The id of the default channel for an app.

Inherited constants

Fields

public static final Creator<NotificationChannel> CREATOR

Public constructors

NotificationChannel(String id, CharSequence name, int importance)

Creates a notification channel.

Public methods

boolean canBypassDnd()

Whether or not notifications posted to this channel can bypass the Do Not Disturb NotificationManager.INTERRUPTION_FILTER_PRIORITY mode.

boolean canShowBadge()

Returns whether notifications posted to this channel can appear as badges in a Launcher application.

int describeContents()

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

void enableLights(boolean lights)

Sets whether notifications posted to this channel should display notification lights, on devices that support that feature.

void enableVibration(boolean vibration)

Sets whether notification posted to this channel should vibrate.

boolean equals(Object o)

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

AudioAttributes getAudioAttributes()

Returns the audio attributes for sound played by notifications posted to this channel.

String getDescription()

Returns the user visible description of this channel.

String getGroup()

Returns what group this channel belongs to.

String getId()

Returns the id of this channel.

int getImportance()

Returns the user specified importance e.g.

int getLightColor()

Returns the notification light color for notifications posted to this channel.

int getLockscreenVisibility()

Returns whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.

CharSequence getName()

Returns the user visible name of this channel.

Uri getSound()

Returns the notification sound for this channel.

long[] getVibrationPattern()

Returns the vibration pattern for notifications posted to this channel.

int hashCode()

Returns a hash code value for the object.

void setBypassDnd(boolean bypassDnd)

Sets whether or not notifications posted to this channel can interrupt the user in NotificationManager.INTERRUPTION_FILTER_PRIORITY mode.

void setDescription(String description)

Sets the user visible description of this channel.

void setGroup(String groupId)

Sets what group this channel belongs to.

void setImportance(int importance)

Sets the level of interruption of this notification channel.

void setLightColor(int argb)

Sets the notification light color for notifications posted to this channel, if lights are enabled on this channel and the device supports that feature.

void setLockscreenVisibility(int lockscreenVisibility)

Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form.

void setName(CharSequence name)

Sets the user visible name of this channel.

void setShowBadge(boolean showBadge)

Sets whether notifications posted to this channel can appear as application icon badges in a Launcher.

void setSound(Uri sound, AudioAttributes audioAttributes)

Sets the sound that should be played for notifications posted to this channel and its audio attributes.

void setVibrationPattern(long[] vibrationPattern)

Sets the vibration pattern for notifications posted to this channel.

boolean shouldShowLights()

Returns whether notifications posted to this channel trigger notification lights.

boolean shouldVibrate()

Returns whether notifications posted to this channel always vibrate.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

DEFAULT_CHANNEL_ID

added in API level 26
public static final String DEFAULT_CHANNEL_ID

The id of the default channel for an app. This id is reserved by the system. All notifications posted from apps targeting Build.VERSION_CODES.N_MR1 or earlier without a notification channel specified are posted to this channel.

Constant Value: "miscellaneous"

Fields

CREATOR

added in API level 26
public static final Creator<NotificationChannel> CREATOR

Public constructors

NotificationChannel

added in API level 26
public NotificationChannel (String id, 
                CharSequence name, 
                int importance)

Creates a notification channel.

Parameters
id String: The id of the channel. Must be unique per package. The value may be truncated if it is too long.

name CharSequence: The user visible name of the channel. You can rename this channel 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.

importance int: The importance of the channel. This controls how interruptive notifications posted to this channel are.

Value is IMPORTANCE_UNSPECIFIED, IMPORTANCE_NONE, IMPORTANCE_MIN, IMPORTANCE_LOW, IMPORTANCE_DEFAULT or IMPORTANCE_HIGH.

Public methods

canBypassDnd

added in API level 26
public boolean canBypassDnd ()

Whether or not notifications posted to this channel can bypass the Do Not Disturb NotificationManager.INTERRUPTION_FILTER_PRIORITY mode.

Returns
boolean

canShowBadge

added in API level 26
public boolean canShowBadge ()

Returns whether notifications posted to this channel can appear as badges in a Launcher application. Note that badging may be disabled for other reasons.

Returns
boolean

describeContents

added in API level 26
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(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.

enableLights

added in API level 26
public void enableLights (boolean lights)

Sets whether notifications posted to this channel should display notification lights, on devices that support that feature. Only modifiable before the channel is submitted to NotificationManager.createNotificationChannel(NotificationChannel).

Parameters
lights boolean

enableVibration

added in API level 26
public void enableVibration (boolean vibration)

Sets whether notification posted to this channel should vibrate. The vibration pattern can be set with setVibrationPattern(long[]). Only modifiable before the channel is submitted to NotificationManager.createNotificationChannel(NotificationChannel).

Parameters
vibration boolean

equals

added in API level 26
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 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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAudioAttributes

added in API level 26
public AudioAttributes getAudioAttributes ()

Returns the audio attributes for sound played by notifications posted to this channel.

Returns
AudioAttributes

getDescription

added in API level 26
public String getDescription ()

Returns the user visible description of this channel.

Returns
String

getGroup

added in API level 26
public String getGroup ()

Returns what group this channel belongs to. This is used only for visually grouping channels in the UI.

Returns
String

getId

added in API level 26
public String getId ()

Returns the id of this channel.

Returns
String

getImportance

added in API level 26
public int getImportance ()

Returns the user specified importance e.g. NotificationManager.IMPORTANCE_LOW for notifications posted to this channel. Note: This value might be > NotificationManager.IMPORTANCE_NONE, but notifications posted to this channel will not be shown to the user if the parent NotificationChannelGroup or app is blocked. See NotificationChannelGroup.isBlocked() and NotificationManager.areNotificationsEnabled().

Returns
int

getLightColor

added in API level 26
public int getLightColor ()

Returns the notification light color for notifications posted to this channel. Irrelevant unless shouldShowLights().

Returns
int

getLockscreenVisibility

added in API level 26
public int getLockscreenVisibility ()

Returns whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form.

Returns
int

getName

added in API level 26
public CharSequence getName ()

Returns the user visible name of this channel.

Returns
CharSequence

getSound

added in API level 26
public Uri getSound ()

Returns the notification sound for this channel.

Returns
Uri

getVibrationPattern

added in API level 26
public long[] getVibrationPattern ()

Returns the vibration pattern for notifications posted to this channel. Will be ignored if vibration is not enabled (shouldVibrate().

Returns
long[]

hashCode

added in API level 26
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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

setBypassDnd

added in API level 26
public void setBypassDnd (boolean bypassDnd)

Sets whether or not notifications posted to this channel can interrupt the user in NotificationManager.INTERRUPTION_FILTER_PRIORITY mode. Only modifiable by the system and notification ranker.

Parameters
bypassDnd boolean

setDescription

added in API level 26
public void setDescription (String description)

Sets the user visible description of this channel.

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

Parameters
description String

setGroup

added in API level 26
public void setGroup (String groupId)

Sets what group this channel belongs to. Group information is only used for presentation, not for behavior. Only modifiable before the channel is submitted to NotificationManager.createNotificationChannel(NotificationChannel), unless the channel is not currently part of a group.

Parameters
groupId String: the id of a group created by NotificationManager.createNotificationChannelGroup(NotificationChannelGroup).

setImportance

added in API level 26
public void setImportance (int importance)

Sets the level of interruption of this notification channel. Only modifiable before the channel is submitted to NotificationManager.createNotificationChannel(NotificationChannel).

Parameters
importance int: the amount the user should be interrupted by notifications from this channel.

Value is IMPORTANCE_UNSPECIFIED, IMPORTANCE_NONE, IMPORTANCE_MIN, IMPORTANCE_LOW, IMPORTANCE_DEFAULT or IMPORTANCE_HIGH.

setLightColor

added in API level 26
public void setLightColor (int argb)

Sets the notification light color for notifications posted to this channel, if lights are enabled on this channel and the device supports that feature. Only modifiable before the channel is submitted to NotificationManager.createNotificationChannel(NotificationChannel).

Parameters
argb int

setLockscreenVisibility

added in API level 26
public void setLockscreenVisibility (int lockscreenVisibility)

Sets whether notifications posted to this channel appear on the lockscreen or not, and if so, whether they appear in a redacted form. See e.g. Notification.VISIBILITY_SECRET. Only modifiable by the system and notification ranker.

Parameters
lockscreenVisibility int

setName

added in API level 26
public void setName (CharSequence name)

Sets the user visible name of this channel.

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

Parameters
name CharSequence

setShowBadge

added in API level 26
public void setShowBadge (boolean showBadge)

Sets whether notifications posted to this channel can appear as application icon badges in a Launcher. Only modifiable before the channel is submitted to NotificationManager.createNotificationChannel(NotificationChannel).

Parameters
showBadge boolean: true if badges should be allowed to be shown.

setSound

added in API level 26
public void setSound (Uri sound, 
                AudioAttributes audioAttributes)

Sets the sound that should be played for notifications posted to this channel and its audio attributes. Notification channels with an importance of at least NotificationManager.IMPORTANCE_DEFAULT should have a sound. Only modifiable before the channel is submitted to NotificationManager.createNotificationChannel(NotificationChannel).

Parameters
sound Uri

audioAttributes AudioAttributes

setVibrationPattern

added in API level 26
public void setVibrationPattern (long[] vibrationPattern)

Sets the vibration pattern for notifications posted to this channel. If the provided pattern is valid (non-null, non-empty), will enableVibration(boolean) enable vibration} as well. Otherwise, vibration will be disabled. Only modifiable before the channel is submitted to NotificationManager.createNotificationChannel(NotificationChannel).

Parameters
vibrationPattern long

shouldShowLights

added in API level 26
public boolean shouldShowLights ()

Returns whether notifications posted to this channel trigger notification lights.

Returns
boolean

shouldVibrate

added in API level 26
public boolean shouldVibrate ()

Returns whether notifications posted to this channel always vibrate.

Returns
boolean

toString

added in API level 26
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

added in API level 26
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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.