Most visited

Recently visited

Results for

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

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<NotificationChannel>`	`CREATOR`

Public constructors
`NotificationChannel(String id, CharSequence name, int importance)` Creates a notification channel.

Public methods
`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.
`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`	`getConversationId()` Returns the `ShortcutInfo#getId()` of the conversation backing this channel, if it's associated with a conversation.
`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. `NotificationManager#IMPORTANCE_LOW` for notifications posted to this channel.
`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.
`String`	`getParentChannelId()` Returns the `id` of the parent notification channel to this channel, if it's a conversation related channel.
`Uri`	`getSound()` Returns the notification sound for this channel.
`long[]`	`getVibrationPattern()` Returns the vibration pattern for notifications posted to this channel.
`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.
`boolean`	`hasUserSetSound()` Returns whether the user has chosen the sound of this channel.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isImportantConversation()` Whether or not notifications in this conversation are considered important.
`void`	`setAllowBubbles(boolean allowBubbles)` As of Android 11 this value is no longer respected.
`void`	`setBypassDnd(boolean bypassDnd)` Sets whether or not notifications posted to this channel can interrupt the user in `NotificationManager.INTERRUPTION_FILTER_PRIORITY` mode.
`void`	`setConversationId(String parentChannelId, String conversationId)` Sets this channel as being converastion-centric.
`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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

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"

Fields

CREATOR

public static final Creator<NotificationChannel> CREATOR

Public constructors

NotificationChannel

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 `NotificationManager.IMPORTANCE_UNSPECIFIED`, `NotificationManager.IMPORTANCE_NONE`, `NotificationManager.IMPORTANCE_MIN`, `NotificationManager.IMPORTANCE_LOW`, `NotificationManager.IMPORTANCE_DEFAULT`, or `NotificationManager.IMPORTANCE_HIGH`

Public methods

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.

Returns
`boolean`

See also:

Notification.getBubbleMetadata()

canBypassDnd

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

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

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`

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

Parameters
`lights`	`boolean`

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

Parameters
`vibration`	`boolean`

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.

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

public AudioAttributes getAudioAttributes ()

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

Returns
`AudioAttributes`

getConversationId

public String getConversationId ()

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

Returns
`String`	This value may be `null`.

getDescription

public String getDescription ()

Returns the user visible description of this channel.

Returns
`String`

getGroup

public String getGroup ()

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

Returns
`String`

getId

public String getId ()

Returns the id of this channel.

Returns
`String`

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

Returns
`int`

getLightColor

public int getLightColor ()

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

Returns
`int`

getLockscreenVisibility

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

public CharSequence getName ()

Returns the user visible name of this channel.

Returns
`CharSequence`

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

Returns
`String`	This value may be `null`.

getSound

public Uri getSound ()

Returns the notification sound for this channel.

Returns
`Uri`

getVibrationPattern

public long[] getVibrationPattern ()

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

Returns
`long[]`

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.

Returns
`boolean`

See also:

getImportance()

hasUserSetSound

public boolean hasUserSetSound ()

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

Returns
`boolean`

See also:

getSound()

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

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, those with a valid conversation id.

Returns
`boolean`

setAllowBubbles

public void setAllowBubbles (boolean allowBubbles)

As of Android 11 this value is no longer respected.

Parameters
`allowBubbles`	`boolean`

See also:

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.

Parameters
`bypassDnd`	`boolean`

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.

Parameters
`parentChannelId`	`String`: The `getId()` id} of the generic channel that notifications of this type would be posted to in absence of a specific conversation id. For example, if this channel represents 'Messages from Person A', the parent channel would be 'Messages.' This value cannot be `null`.
`conversationId`	`String`: The `ShortcutInfo#getId()` of the shortcut representing this channel's conversation. This value cannot be `null`.

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.

Parameters
`description`	`String`

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.

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

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

Parameters
`importance`	`int`: the amount the user should be interrupted by notifications from this channel. Value is `NotificationManager.IMPORTANCE_UNSPECIFIED`, `NotificationManager.IMPORTANCE_NONE`, `NotificationManager.IMPORTANCE_MIN`, `NotificationManager.IMPORTANCE_LOW`, `NotificationManager.IMPORTANCE_DEFAULT`, or `NotificationManager.IMPORTANCE_HIGH`

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

Parameters
`argb`	`int`

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.

Parameters
`lockscreenVisibility`	`int`

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.

Parameters
`name`	`CharSequence`

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

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

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. Only modifiable before the channel is submitted to NotificationManager#createNotificationChannel(NotificationChannel).

Parameters
`sound`	`Uri`
`audioAttributes`	`AudioAttributes`

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

public boolean shouldShowLights ()

Returns whether notifications posted to this channel trigger notification lights.

Returns
`boolean`

shouldVibrate

public boolean shouldVibrate ()

Returns whether notifications posted to this channel always vibrate.

Returns
`boolean`

toString

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

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`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES