NotificationChannel

DEFAULT_CHANNEL_ID

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"

EDIT_CONVERSATION

public static final String EDIT_CONVERSATION

Extra value for Settings#EXTRA_CHANNEL_FILTER_LIST. Include to show fields that have to do with editing conversation settings (demoting or restoring a channel to be a Conversation, changing bubble behavior, or setting the priority of a conversation).

Constant Value: "conversation"

EDIT_IMPORTANCE

public static final String EDIT_IMPORTANCE

Extra value for Settings#EXTRA_CHANNEL_FILTER_LIST. Include to show fields that have to do with editing importance (setImportance(int)) and/or conversation priority.

Constant Value: "importance"

EDIT_LAUNCHER

public static final String EDIT_LAUNCHER

Extra value for Settings#EXTRA_CHANNEL_FILTER_LIST. Include to show fields that have to do with editing launcher behavior (showing badges)}.

Constant Value: "launcher"

EDIT_LOCKED_DEVICE

public static final String EDIT_LOCKED_DEVICE

Extra value for Settings#EXTRA_CHANNEL_FILTER_LIST. Include to show fields that have to do with editing behavior on devices that are locked or have a turned off display (setLockscreenVisibility(int), enableLights(boolean), setLightColor(int)).

Constant Value: "locked"

EDIT_SOUND

public static final String EDIT_SOUND

Extra value for Settings#EXTRA_CHANNEL_FILTER_LIST. Include to show fields that have to do with editing sound, like a tone picker (setSound(android.net.Uri, android.media.AudioAttributes)).

Constant Value: "sound"

EDIT_VIBRATION

public static final String EDIT_VIBRATION

Extra value for Settings#EXTRA_CHANNEL_FILTER_LIST. Include to show fields that have to do with editing vibration (enableVibration(boolean), setVibrationPattern(long[])).

Constant Value: "vibration"

EDIT_ZEN

public static final String EDIT_ZEN

Extra value for Settings#EXTRA_CHANNEL_FILTER_LIST. Include to show fields that have to do with editing do not disturb bypass {(@link #setBypassDnd(boolean)}) .

Constant Value: "zen"

CREATOR

public static final Creator<NotificationChannel> CREATOR

NotificationChannel

public NotificationChannel (String id, 
                CharSequence name, 
                int importance)

Creates a notification channel.

canBubble

public boolean canBubble ()

Returns whether notifications posted to this channel are allowed to display outside of the notification shade, in a floating window on top of other apps.

canBypassDnd

public boolean canBypassDnd ()

Whether or not notifications posted to this channel can bypass the Do Not Disturb NotificationManager#INTERRUPTION_FILTER_PRIORITY mode when the active policy allows priority channels to bypass notification filtering.

canShowBadge

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.

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.

enableLights

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).

enableVibration

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).

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 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.

getAudioAttributes

public AudioAttributes getAudioAttributes ()

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

getConversationId

public String getConversationId ()

Returns the id of the conversation backing this channel, if it's associated with a conversation. See setConversationId(java.lang.String, java.lang.String).

getDescription

public String getDescription ()

Returns the user visible description of this channel.

getGroup

public String getGroup ()

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

getId

public String getId ()

Returns the id of this channel.

getImportance

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().

getLightColor

public int getLightColor ()

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

getLockscreenVisibility

public int getLockscreenVisibility ()

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

getName

public CharSequence getName ()

Returns the user visible name of this channel.

getParentChannelId

public String getParentChannelId ()

Returns the id of the parent notification channel to this channel, if it's a conversation related channel. See setConversationId(java.lang.String, java.lang.String).

getSound

public Uri getSound ()

Returns the notification sound for this channel.

getVibrationEffect

public VibrationEffect getVibrationEffect ()

Returns the VibrationEffect for notifications posted to this channel. The returned effect is derived from either the effect provided in the setVibrationEffect(android.os.VibrationEffect) method, or the equivalent vibration effect of the pattern set via the setVibrationPattern(long[]) method, based on setter method that was called last. The returned effect will be ignored in one of the following cases:

• vibration is not enabled for the channel (i.e. shouldVibrate() returns false).
• the effect is not supported/playable by the device. In this case, if vibration is enabled for the channel, the default channel vibration will be used instead.

getVibrationPattern

public long[] getVibrationPattern ()

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

hasUserSetImportance

public boolean hasUserSetImportance ()

Returns whether the user has chosen the importance of this channel, either to affirm the initial selection from the app, or changed it to be higher or lower.

hasUserSetSound

public boolean hasUserSetSound ()

Returns whether the user has chosen the sound of this channel.

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 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 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 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.

isBlockable

public boolean isBlockable ()

Returns whether this channel is always blockable, even if the app is 'fixed' as non-blockable.

isConversation

public boolean isConversation ()

Whether or not this channel represents a conversation.

isDemoted

public boolean isDemoted ()

Returns whether the user has decided that this channel does not represent a conversation. The value will always be false for channels that never claimed to be conversations - that is, for channels where getConversationId() and getParentChannelId() are empty.

isImportantConversation

public boolean isImportantConversation ()

Whether or not notifications in this conversation are considered important.

Important conversations may get special visual treatment, and might be able to bypass DND.

This is only valid for channels that represent conversations, that is, where isConversation() is true.

setAllowBubbles

public void setAllowBubbles (boolean allowBubbles)

As of Android 11 this value is no longer respected.

setBlockable

public void setBlockable (boolean blockable)

Allows users to block notifications sent through this channel, if this channel belongs to a package that otherwise would have notifications "fixed" as enabled. If the channel does not belong to a package that has a fixed notification permission, this method does nothing, since such channels are blockable by default and cannot be set to be unblockable.

setBypassDnd

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.

setConversationId

public void setConversationId (String parentChannelId, 
                String conversationId)

Sets this channel as being converastion-centric. Different settings and functionality may be exposed for conversation-centric channels.

setDescription

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.

setGroup

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.

setImportance

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).

setLightColor

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).

setLockscreenVisibility

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.

setName

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.

setShowBadge

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).

setSound

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. Note: An app-specific sound can be provided in the Uri parameter, but because channels are persistent for the duration of the app install, and are backed up and restored, the Uri should be stable. For this reason it is not recommended to use a ContentResolver#SCHEME_ANDROID_RESOURCE uri, as resource ids can change on app upgrade. Only modifiable before the channel is submitted to NotificationManager#createNotificationChannel(NotificationChannel).

setVibrationEffect

public void setVibrationEffect (VibrationEffect effect)

Sets a VibrationEffect for notifications posted to this channel. If the provided effect is non-null, will enable vibration on this channel (equivalent to calling enableVibration(boolean) with true). Otherwise vibration will be disabled unless enableVibration(boolean) is used with true, in which case the default vibration will be used.

The effect passed here will be returned from getVibrationEffect(). If the provided VibrationEffect is an equivalent to a wave-form vibration pattern, the equivalent wave-form pattern will be returned from getVibrationPattern().

Note that some VibrationEffects may not be playable on some devices. In cases where such an effect is passed here, vibration will still be enabled for the channel, but the default vibration will be used. Nonetheless, the provided effect will be stored and be returned from getVibrationEffect() calls, and could be used by the same channel on a different device, for example, in cases the user backs up and restores to a device that does have the ability to play the effect, where that effect will be used instead of the default. To avoid such issues that could make the vibration behavior of your notification channel differ among different devices, it's recommended that you avoid vibration effect primitives, as the support for them differs widely among devices (read VibrationEffect.Composition for more on vibration primitives).

Only modifiable before the channel is submitted to NotificationManager#createNotificationChannel(NotificationChannel).

setVibrationPattern

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 with at least 1 non-zero value), will enable vibration on this channel (equivalent to calling enableVibration(boolean) with true). Otherwise, vibration will be disabled unless enableVibration(boolean) is used with true, in which case the default vibration will be used. Only modifiable before the channel is submitted to NotificationManager#createNotificationChannel(NotificationChannel).

shouldShowLights

public boolean shouldShowLights ()

Returns whether notifications posted to this channel trigger notification lights.

shouldVibrate

public boolean shouldVibrate ()

Returns whether notifications posted to this channel always vibrate.

toString

public String toString ()

Returns a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.