NotificationManagerCompat

const val ACTION_BIND_SIDE_CHANNEL = "android.support.BIND_NOTIFICATION_SIDE_CHANNEL": String!

Intent action to register for on a service to receive side channel notifications. The listening service must be in the same package as an enabled NotificationListenerService.

const val EXTRA_USE_SIDE_CHANNEL = "android.support.useSideChannel": String!

Notification extras key: if set to true, the posted notification should use the side channel for delivery instead of using notification manager.

const val IMPORTANCE_DEFAULT = 3: Int

Default notification importance: shows everywhere, allowed to makes noise, but does not visually intrude.

const val IMPORTANCE_HIGH = 4: Int

Higher notification importance: shows everywhere, allowed to makes noise and peek.

const val IMPORTANCE_LOW = 2: Int

Low notification importance: shows everywhere, but is not intrusive.

const val IMPORTANCE_MAX = 5: Int

Highest notification importance: shows everywhere, allowed to makes noise, peek, and use full screen intents.

const val IMPORTANCE_MIN = 1: Int

Min notification importance: only shows in the shade, below the fold.

const val IMPORTANCE_NONE = 0: Int

A notification with no importance: shows nowhere, is blocked.

const val IMPORTANCE_UNSPECIFIED = -1000: Int

Value signifying that the user has not expressed an importance. This value is for persisting preferences, and should never be associated with an actual notification.

const val INTERRUPTION_FILTER_ALARMS = 4: Int

Interruption filter constant - Alarms only interruption filter - all notifications except those of category CATEGORY_ALARM are suppressed. Some audio streams are muted.

const val INTERRUPTION_FILTER_ALL = 1: Int

Interruption filter constant - Normal interruption filter - no notifications are suppressed.

const val INTERRUPTION_FILTER_NONE = 3: Int

Interruption filter constant - No interruptions filter - all notifications are suppressed and all audio streams (except those used for phone calls) and vibrations are muted.

const val INTERRUPTION_FILTER_PRIORITY = 2: Int

Interruption filter constant - Priority interruption filter - all notifications are suppressed except those that match the priority criteria. Some audio streams are muted. See priorityCallSenders, priorityCategories, priorityMessageSenders to define or query this criteria. Users can additionally specify packages that can bypass this interruption filter.

const val INTERRUPTION_FILTER_UNKNOWN = 0: Int

Interruption filter constant - returned when the value is unavailable for any reason.

fun areNotificationsEnabled(): Boolean

Returns whether notifications from the calling package are not blocked.

fun canPostPromotedNotifications(): Boolean

Returns whether the calling app's properly formatted notifications can appear in a promoted format, which may result in higher ranking, appearances on additional surfaces, and richer presentation. Apps can request this permission by sending the user to the activity that matches the system intent action ACTION_APP_NOTIFICATION_PROMOTION_SETTINGS.

fun canUseFullScreenIntent(): Boolean

Returns whether the calling app can send fullscreen intents.

Fullscreen intents were introduced in Android HONEYCOMB, where apps could always attach a full screen intent to their notification via setFullScreenIntent}.

Android Q introduced the USE_FULL_SCREEN_INTENT permission, where SystemUI will only show the full screen intent attached to a notification if the permission is declared in the manifest.

Starting from Android UPSIDE_DOWN_CAKE, apps may not have permission to use USE_FULL_SCREEN_INTENT. If the FSI permission is denied, SystemUI will show the notification as an expanded heads up notification on lockscreen.

To request access, add the USE_FULL_SCREEN_INTENT permission to your manifest, and use ACTION_MANAGE_APP_USE_FULL_SCREEN_INTENT to send the user to the settings page where they can grant your app the FSI permission.

fun cancel(id: Int): Unit

Cancel a previously shown notification.

fun cancel(tag: String?, id: Int): Unit

Cancel a previously shown notification.

fun cancelAll(): Unit

Cancel all previously shown notifications.

fun createNotificationChannel(channel: NotificationChannel): Unit

Creates a notification channel that notifications can be posted to. This can also be used to restore a deleted channel and to update an existing channel's name, description, group, and/or importance.

The importance of an existing channel will only be changed if the new importance is lower than the current value and the user has not altered any settings on this channel.

The group of an existing channel will only be changed if the channel does not already belong to a group. All other fields are ignored for channels that already exist. It doesn't do anything on older SDKs which don't support Notification Channels.

fun createNotificationChannel(channel: NotificationChannelCompat): Unit

Creates a notification channel that notifications can be posted to. This can also be used to restore a deleted channel and to update an existing channel's name, description, group, and/or importance.

The importance of an existing channel will only be changed if the new importance is lower than the current value and the user has not altered any settings on this channel.

The group of an existing channel will only be changed if the channel does not already belong to a group. All other fields are ignored for channels that already exist. It doesn't do anything on older SDKs which don't support Notification Channels.

fun createNotificationChannelGroup(group: NotificationChannelGroup): Unit

Creates a group container for NotificationChannel objects. This can be used to rename an existing group. It doesn't do anything on older SDKs which don't support Notification Channels.

fun createNotificationChannelGroup(group: NotificationChannelGroupCompat): Unit

Creates a group container for NotificationChannel objects. This can be used to rename an existing group. It doesn't do anything on older SDKs which don't support Notification Channels.

fun createNotificationChannelGroups(
    groups: (Mutable)List<NotificationChannelGroup!>
): Unit

Creates multiple notification channel groups. See createNotificationChannelGroup. It doesn't do anything on older SDKs which don't support Notification Channels.

fun createNotificationChannelGroupsCompat(
    groups: (Mutable)List<NotificationChannelGroupCompat!>
): Unit

Creates multiple notification channel groups. See createNotificationChannelGroup. It doesn't do anything on older SDKs which don't support Notification Channels.

fun createNotificationChannels(
    channels: (Mutable)List<NotificationChannel!>
): Unit

Creates multiple notification channels that different notifications can be posted to. See createNotificationChannel. It doesn't do anything on older SDKs which don't support Notification Channels.

fun createNotificationChannelsCompat(
    channels: (Mutable)List<NotificationChannelCompat!>
): Unit

Creates multiple notification channels that different notifications can be posted to. See createNotificationChannel. It doesn't do anything on older SDKs which don't support Notification Channels.

fun deleteNotificationChannel(channelId: String): Unit

Deletes the given notification channel.

If you create a new channel with this same id, the deleted channel will be un-deleted with all of the same settings it had before it was deleted. It doesn't do anything on older SDKs which don't support Notification Channels.

fun deleteNotificationChannelGroup(groupId: String): Unit

Deletes the given notification channel group, and all notification channels that belong to it. It doesn't do anything on older SDKs which don't support Notification Channels.

fun deleteUnlistedNotificationChannels(
    channelIds: (Mutable)Collection<String!>
): Unit

Deletes notification channels for which ids are NOT given. This will NOT delete channels which are conversation children of the given channels. It doesn't do anything on older SDKs which don't support Notification Channels.

java-static fun from(context: Context): NotificationManagerCompat

Get a NotificationManagerCompat instance for a provided context.

fun getActiveNotifications(): (Mutable)List<StatusBarNotification!>

Recover a list of active notifications: ones that have been posted by the calling app that have not yet been dismissed by the user or canceled by the app.

StatusBarNotification object, including the original and supplied to (via and ) as well as a copy of the original object (via ).

From Q, will also return notifications you've posted as an app's notification delegate via notifyAsPackage.

Returns an empty list on LOLLIPOP_MR1 and earlier.

fun getCurrentInterruptionFilter(): Int

Gets the current notification interruption filter.

The interruption filter defines which notifications are allowed to interrupt the user (e.g. via sound &vibration) and is applied globally.

java-static fun getEnabledListenerPackages(context: Context): (Mutable)Set<String!>

Get the set of packages that have an enabled notification listener component within them.

fun getImportance(): Int

Returns the user specified importance for notifications from the calling package.

fun getNotificationChannel(channelId: String): NotificationChannel?

Returns the notification channel settings for a given channel id. Returns null on older SDKs which don't support Notification Channels.

fun getNotificationChannel(channelId: String, conversationId: String): NotificationChannel?

Returns the notification channel settings for a given channel and conversation id. Returns the channel for the channelId on older SDKs which don't support Conversations. Returns null on older SDKs which don't support Notification Channels.

fun getNotificationChannelCompat(channelId: String): NotificationChannelCompat?

Returns the notification channel settings for a given channel id. Returns null on older SDKs which don't support Notification Channels.

fun getNotificationChannelCompat(channelId: String, conversationId: String): NotificationChannelCompat?

Returns the notification channel settings for a given channel and conversation id. Returns the channel for the channelId on older SDKs which don't support Conversations. Returns null on older SDKs which don't support Notification Channels.

fun getNotificationChannelGroup(channelGroupId: String): NotificationChannelGroup?

Returns the notification channel group settings for a given channel group id. Returns null on older SDKs which don't support Notification Channels.

fun getNotificationChannelGroupCompat(channelGroupId: String): NotificationChannelGroupCompat?

Returns the notification channel group settings for a given channel group id. Returns null on older SDKs which don't support Notification Channels.

fun getNotificationChannelGroups(): (Mutable)List<NotificationChannelGroup!>

Returns all notification channel groups belonging to the calling app or an empty list on older SDKs which don't support Notification Channels.

fun getNotificationChannelGroupsCompat(): (Mutable)List<NotificationChannelGroupCompat!>

Returns all notification channel groups belonging to the calling app or an empty list on older SDKs which don't support Notification Channels.

fun getNotificationChannels(): (Mutable)List<NotificationChannel!>

Returns all notification channels belonging to the calling app or an empty list on older SDKs which don't support Notification Channels.

fun getNotificationChannelsCompat(): (Mutable)List<NotificationChannelCompat!>

Returns all notification channels belonging to the calling app or an empty list on older SDKs which don't support Notification Channels.

@RequiresPermission(value = Manifest.permission.POST_NOTIFICATIONS)
fun notify(
    notificationWithIdAndTags: (Mutable)List<NotificationManagerCompat.NotificationWithIdAndTag!>
): Unit

Post a number of notifications, to be shown in the status bar, stream, etc. Each notification will attempt to be posted in the order provided in the notificationWithIds list. Each notification must have a provided id and may have a provided tag. This is the preferred method for posting groups of notifications, to improve sound and animation behavior.

@RequiresPermission(value = Manifest.permission.POST_NOTIFICATIONS)
fun notify(id: Int, notification: Notification): Unit

Post a notification to be shown in the status bar, stream, etc.

@RequiresPermission(value = Manifest.permission.POST_NOTIFICATIONS)
fun notify(tag: String?, id: Int, notification: Notification): Unit

Post a notification to be shown in the status bar, stream, etc.