NotificationUtil

@UnstableApi
class NotificationUtil

Utility methods for displaying Notifications.

Summary

Nested types
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(value = )
annotation NotificationUtil.Importance

Notification channel importance levels.

Constants
const Int
const Int
const Int
const Int
const Int
const Int

Public functions
java-static Unit
createNotificationChannel(
    context: Context!,
    id: String!,
    nameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    @NotificationUtil.Importance importance: Int
)

Creates a notification channel that notifications can be posted to.
java-static Unit
setNotification(context: Context!, id: Int, notification: Notification?)

Post a notification to be shown in the status bar.

Constants

IMPORTANCE_DEFAULT

const val IMPORTANCE_DEFAULT = 3: Int
See also
IMPORTANCE_DEFAULT

IMPORTANCE_HIGH

const val IMPORTANCE_HIGH = 4: Int
See also
IMPORTANCE_HIGH

IMPORTANCE_LOW

const val IMPORTANCE_LOW = 2: Int
See also
IMPORTANCE_LOW

IMPORTANCE_MIN

const val IMPORTANCE_MIN = 1: Int
See also
IMPORTANCE_MIN

IMPORTANCE_NONE

const val IMPORTANCE_NONE = 0: Int
See also
IMPORTANCE_NONE

IMPORTANCE_UNSPECIFIED

const val IMPORTANCE_UNSPECIFIED = -1000: Int
See also
IMPORTANCE_UNSPECIFIED

Public functions

createNotificationChannel

java-static fun createNotificationChannel(
    context: Context!,
    id: String!,
    nameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    @NotificationUtil.Importance importance: Int
): Unit

Creates a notification channel that notifications can be posted to. See and createNotificationChannel for details.

Parameters
context: Context!

A Context.
id: String!

The id of the channel. Must be unique per package. The value may be truncated if it's too long.
nameResourceId: @StringRes Int

A string resource identifier for the user visible name of the channel. The recommended maximum length is 40 characters. The string may be truncated if it's too long. You can rename the channel when the system locale changes by listening for the ACTION_LOCALE_CHANGED broadcast.
descriptionResourceId: @StringRes Int

A string resource identifier for the user visible description of the channel, or 0 if no description is provided. The recommended maximum length is 300 characters. The value may be truncated if it is too long. You can change the description of the channel when the system locale changes by listening for the ACTION_LOCALE_CHANGED broadcast.
@NotificationUtil.Importance importance: Int

The importance of the channel. This controls how interruptive notifications posted to this channel are. One of IMPORTANCE_UNSPECIFIED, IMPORTANCE_NONE, IMPORTANCE_MIN, IMPORTANCE_LOW, IMPORTANCE_DEFAULT and IMPORTANCE_HIGH.

setNotification

java-static fun setNotification(context: Context!, id: Int, notification: Notification?): Unit

Post a notification to be shown in the status bar. If a notification with the same id has already been posted by your application and has not yet been canceled, it will be replaced by the updated information. If notification is null then any notification previously shown with the specified id will be cancelled.

Parameters
context: Context!

A Context.
id: Int

The notification id.
notification: Notification?

The Notification to post, or null to cancel a previously shown notification.