# NotificationChannelCompat

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/app/NotificationChannelCompat.java+class:androidx.core.app.NotificationChannelCompat) Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

*** ** * ** ***


```
public class NotificationChannelCompat
```

<br />

*** ** * ** ***

A representation of settings that apply to a collection of similarly themed notifications. Setters return `this` to allow chaining. This class doesn't do anything on older SDKs which don't support Notification Channels.

## Summary

| ### Nested types |
|---|
| `public class https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat.Builder` Builder class for `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat` objects. |

| ### Constants |
|---|---|
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#DEFAULT_CHANNEL_ID() = "miscellaneous"` The id of the default channel for an app. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#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` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#canBypassDnd()()` Whether or not notifications posted to this channel can bypass the Do Not Disturb `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_PRIORITY` mode. |
| `boolean` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#canShowBadge()()` Returns whether notifications posted to this channel can appear as badges in a Launcher application. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/media/AudioAttributes.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getAudioAttributes()()` Returns the audio attributes for sound played by notifications posted to this channel. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getConversationId()()` Returns the `https://developer.android.com/reference/androidx/core/content/pm/ShortcutInfoCompat#getId()` of the conversation backing this channel, if it's associated with a conversation. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getDescription()()` Returns the user visible description of this channel. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getGroup()()` Returns what group this channel belongs to. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getId()()` Returns the id of this channel. |
| `int` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getImportance()()` Returns the user specified importance e.g. `https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_LOW()` for notifications posted to this channel. |
| `int` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getLightColor()()` Returns the notification light color for notifications posted to this channel. |
| `int` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getLockscreenVisibility()()` Returns whether or not notifications posted to this channel are shown on the lockscreen in full or redacted form. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/CharSequence.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getName()()` Returns the user visible name of this channel. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getParentChannelId()()` Returns the `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getId()` of the parent notification channel to this channel, if it's a conversation related channel. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/net/Uri.html` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getSound()()` Returns the notification sound for this channel. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html long[]` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getVibrationPattern()()` Returns the vibration pattern for notifications posted to this channel. |
| `boolean` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#isImportantConversation()()` Whether or not notifications in this conversation are considered important. |
| `boolean` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#shouldShowLights()()` Returns whether notifications posted to this channel trigger notification lights. |
| `boolean` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#shouldVibrate()()` Returns whether notifications posted to this channel always vibrate. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat.Builder` | `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#toBuilder()()` Creates a `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat.Builder` instance with all the writeable property values of this instance. |

## Constants

### DEFAULT_CHANNEL_ID

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public static final String DEFAULT_CHANNEL_ID = "miscellaneous"
```

The id of the default channel for an app. This id is reserved by the system. All notifications posted from apps targeting `https://developer.android.com/reference/android/os/Build.VERSION_CODES.html#N_MR1` or earlier without a notification channel specified are posted to this channel.

## Public methods

### canBubble

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

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

This is a read-only property which is only valid on instances fetched from the `https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat`.

### canBypassDnd

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public boolean canBypassDnd()
```

Whether or not notifications posted to this channel can bypass the Do Not Disturb `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_PRIORITY` mode.

This is a read-only property which is only valid on instances fetched from the `https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat`.

### canShowBadge

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

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

### getAudioAttributes

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @Nullable AudioAttributes getAudioAttributes()
```

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

### getConversationId

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @Nullable String getConversationId()
```

Returns the `https://developer.android.com/reference/androidx/core/content/pm/ShortcutInfoCompat#getId()` of the conversation backing this channel, if it's associated with a conversation. See `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat.Builder#setConversationId(java.lang.String,java.lang.String)`.

### getDescription

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @Nullable String getDescription()
```

Returns the user visible description of this channel.

### getGroup

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @Nullable String getGroup()
```

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

### getId

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @NonNull String getId()
```

Returns the id of this channel.

### getImportance

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public int getImportance()
```

Returns the user specified importance e.g. `https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_LOW()` for notifications posted to this channel. Note: This value might be \>`https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_NONE()`, but notifications posted to this channel will not be shown to the user if the parent `https://developer.android.com/reference/android/app/NotificationChannelGroup.html` or app is blocked. See `https://developer.android.com/reference/android/app/NotificationChannelGroup.html#isBlocked()` and `https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#areNotificationsEnabled()`.

### getLightColor

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public int getLightColor()
```

Returns the notification light color for notifications posted to this channel. Irrelevant unless `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#shouldShowLights()`.

### getLockscreenVisibility

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public int getLockscreenVisibility()
```

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

This is a read-only property which is only valid on instances fetched from the `https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat`.

### getName

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @Nullable CharSequence getName()
```

Returns the user visible name of this channel.

### getParentChannelId

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @Nullable String getParentChannelId()
```

Returns the `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getId()` of the parent notification channel to this channel, if it's a conversation related channel. See `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat.Builder#setConversationId(java.lang.String,java.lang.String)`.

### getSound

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @Nullable Uri getSound()
```

Returns the notification sound for this channel.

### getVibrationPattern

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @Nullable long[] getVibrationPattern()
```

Returns the vibration pattern for notifications posted to this channel. Will be ignored if vibration is not enabled (`https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#shouldVibrate()`.

### isImportantConversation

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
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 `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat#getConversationId()`.

This is a read-only property which is only valid on instances fetched from the `https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat`.

### shouldShowLights

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public boolean shouldShowLights()
```

Returns whether notifications posted to this channel trigger notification lights.

### shouldVibrate

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public boolean shouldVibrate()
```

Returns whether notifications posted to this channel always vibrate.

### toBuilder

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)

```
public @NonNull NotificationChannelCompat.Builder toBuilder()
```

Creates a `https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat.Builder` instance with all the writeable property values of this instance.