NotificationChannel

DEFAULT_CHANNEL_ID

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 N_MR1 or earlier without a notification channel specified are posted to this channel.

Constant Value: "miscellaneous"

CREATOR

Creator<NotificationChannel> CREATOR

NotificationChannel

NotificationChannel (String id, 
                CharSequence name, 
                int importance)

Creates a notification channel.

canBypassDnd

boolean canBypassDnd ()

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

canShowBadge

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

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.

enableLights

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 notify(String, int, Notification).

enableVibration

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 notify(String, int, Notification).

equals

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.

getAudioAttributes

AudioAttributes getAudioAttributes ()

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

getDescription

String getDescription ()

Returns the user visible description of this channel.

getGroup

String getGroup ()

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

getId

String getId ()

Returns the id of this channel.

getImportance

int getImportance ()

Returns the user specified importance e.g. IMPORTANCE_LOW for notifications posted to this channel.

getLightColor

int getLightColor ()

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

getLockscreenVisibility

int getLockscreenVisibility ()

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

getName

CharSequence getName ()

Returns the user visible name of this channel.

getSound

Uri getSound ()

Returns the notification sound for this channel.

getVibrationPattern

long[] getVibrationPattern ()

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

hashCode

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

setBypassDnd

void setBypassDnd (boolean bypassDnd)

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

setDescription

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

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 notify(String, int, Notification).

setImportance

void setImportance (int importance)

Sets the level of interruption of this notification channel. Only modifiable before the channel is submitted to notify(String, int, Notification).

setLightColor

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 notify(String, int, Notification).

setLockscreenVisibility

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. VISIBILITY_SECRET. Only modifiable by the system and notification ranker.

setName

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

void setShowBadge (boolean showBadge)

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

setSound

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 IMPORTANCE_DEFAULT should have a sound. Only modifiable before the channel is submitted to notify(String, int, Notification).

setVibrationPattern

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 notify(String, int, Notification).

shouldShowLights

boolean shouldShowLights ()

Returns whether notifications posted to this channel trigger notification lights.

shouldVibrate

boolean shouldVibrate ()

Returns whether notifications posted to this channel always vibrate.

toString

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

writeToParcel

void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.