added in version 22.1.0
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1

Summary: Constants | Methods | Inherited Methods | [Expand All]

NotificationManagerCompat

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public final class NotificationManagerCompat
extends Object

java.lang.Object
↳	android.support.v4.app.NotificationManagerCompat

---

Compatibility library for NotificationManager with fallbacks for older platforms.

To use this class, call the static function from(Context) to get a NotificationManagerCompat object, and then call one of its methods to post or cancel notifications.

Summary

Constants
String	ACTION_BIND_SIDE_CHANNEL Intent action to register for on a service to receive side channel notifications.
String	EXTRA_USE_SIDE_CHANNEL Notification extras key: if set to true, the posted notification should use the side channel for delivery instead of using notification manager.
int	IMPORTANCE_DEFAULT Default notification importance: shows everywhere, allowed to makes noise, but does not visually intrude.
int	IMPORTANCE_HIGH Higher notification importance: shows everywhere, allowed to makes noise and peek.
int	IMPORTANCE_LOW Low notification importance: shows everywhere, but is not intrusive.
int	IMPORTANCE_MAX Highest notification importance: shows everywhere, allowed to makes noise, peek, and use full screen intents.
int	IMPORTANCE_MIN Min notification importance: only shows in the shade, below the fold.
int	IMPORTANCE_NONE A notification with no importance: shows nowhere, is blocked.
int	IMPORTANCE_UNSPECIFIED Value signifying that the user has not expressed an importance.

Public methods
boolean	areNotificationsEnabled() Returns whether notifications from the calling package are not blocked.
void	cancel(String tag, int id) Cancel a previously shown notification.
void	cancel(int id) Cancel a previously shown notification.
void	cancelAll() Cancel all previously shown notifications.
static NotificationManagerCompat	from(Context context) Get a NotificationManagerCompat instance for a provided context.
static Set<String>	getEnabledListenerPackages(Context context) Get the set of packages that have an enabled notification listener component within them.
int	getImportance() Returns the user specified importance for notifications from the calling package.
void	notify(int id, Notification notification) Post a notification to be shown in the status bar, stream, etc.
void	notify(String tag, int id, Notification notification) Post a notification to be shown in the status bar, stream, etc.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Constants

ACTION_BIND_SIDE_CHANNEL

added in version 22.1.0

String ACTION_BIND_SIDE_CHANNEL

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.

Constant Value: "android.support.BIND_NOTIFICATION_SIDE_CHANNEL"

EXTRA_USE_SIDE_CHANNEL

added in version 22.1.0

String EXTRA_USE_SIDE_CHANNEL

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

Constant Value: "android.support.useSideChannel"

IMPORTANCE_DEFAULT

added in version 24.1.0

int IMPORTANCE_DEFAULT

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

Constant Value: 3 (0x00000003)

IMPORTANCE_HIGH

added in version 24.1.0

int IMPORTANCE_HIGH

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

Constant Value: 4 (0x00000004)

IMPORTANCE_LOW

added in version 24.1.0

int IMPORTANCE_LOW

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

Constant Value: 2 (0x00000002)

IMPORTANCE_MAX

added in version 24.1.0

int IMPORTANCE_MAX

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

Constant Value: 5 (0x00000005)

IMPORTANCE_MIN

added in version 24.1.0

int IMPORTANCE_MIN

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

Constant Value: 1 (0x00000001)

IMPORTANCE_NONE

added in version 24.1.0

int IMPORTANCE_NONE

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

Constant Value: 0 (0x00000000)

IMPORTANCE_UNSPECIFIED

added in version 24.1.0

int IMPORTANCE_UNSPECIFIED

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.

Constant Value: -1000 (0xfffffc18)

Public methods

areNotificationsEnabled

added in version 24.1.0

boolean areNotificationsEnabled ()

Returns whether notifications from the calling package are not blocked.

Returns
boolean

cancel

added in version 22.1.0

void cancel (String tag, 
                int id)

Cancel a previously shown notification.

Parameters
tag	String: the string identifier of the notification.
id	int: the ID of the notification

cancel

added in version 22.1.0

void cancel (int id)

Cancel a previously shown notification.

Parameters
id	int: the ID of the notification

cancelAll

added in version 22.1.0

void cancelAll ()

Cancel all previously shown notifications.

from

added in version 22.1.0

NotificationManagerCompat from (Context context)

Get a NotificationManagerCompat instance for a provided context.

Parameters
context	Context

Returns
NotificationManagerCompat

getEnabledListenerPackages

added in version 22.1.0

Set<String> getEnabledListenerPackages (Context context)

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

Parameters
context	Context

Returns
Set<String>

getImportance

added in version 24.1.0

int getImportance ()

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

Returns
int	An importance level, such as IMPORTANCE_DEFAULT.

notify

added in version 22.1.0

void notify (int id, 
                Notification notification)

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

Parameters
id	int: the ID of the notification
notification	Notification: the notification to post to the system

notify

added in version 22.1.0

void notify (String tag, 
                int id, 
                Notification notification)

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

Parameters
tag	String: the string identifier for a notification. Can be null.
id	int: the ID of the notification. The pair (tag, id) must be unique within your app.
notification	Notification: the notification to post to the system

• Annotations

  • NotificationCompat.Action.SemanticAction

• Interfaces

  • ActionBarDrawerToggle.Delegate
  • ActionBarDrawerToggle.DelegateProvider
  • ActivityCompat.OnRequestPermissionsResultCallback
  • ActivityCompat.PermissionCompatDelegate
  • FragmentManager.BackStackEntry
  • FragmentManager.OnBackStackChangedListener
  • LoaderManager.LoaderCallbacks
  • NotificationCompat.Action.Extender
  • NotificationCompat.Extender
  • SharedElementCallback.OnSharedElementsReadyListener
  • TaskStackBuilder.SupportParentable

• Classes

  • ActionBarDrawerToggle
  • ActivityCompat
  • ActivityManagerCompat
  • ActivityOptionsCompat
  • AlarmManagerCompat
  • AppLaunchChecker
  • AppOpsManagerCompat
  • BundleCompat
  • DialogFragment
  • Fragment
  • Fragment.SavedState
  • FragmentActivity
  • FragmentContainer
  • FragmentController
  • FragmentHostCallback
  • FragmentManager
  • FragmentManager.FragmentLifecycleCallbacks
  • FragmentManagerNonConfig
  • FragmentPagerAdapter
  • FragmentStatePagerAdapter
  • FragmentTabHost
  • FragmentTransaction
  • FrameMetricsAggregator
  • JobIntentService
  • ListFragment
  • LoaderManager
  • NavUtils
  • NotificationCompat
  • NotificationCompat.Action
  • NotificationCompat.Action.Builder
  • NotificationCompat.Action.WearableExtender
  • NotificationCompat.BigPictureStyle
  • NotificationCompat.BigTextStyle
  • NotificationCompat.Builder
  • NotificationCompat.CarExtender
  • NotificationCompat.CarExtender.UnreadConversation
  • NotificationCompat.CarExtender.UnreadConversation.Builder
  • NotificationCompat.DecoratedCustomViewStyle
  • NotificationCompat.InboxStyle
  • NotificationCompat.MessagingStyle
  • NotificationCompat.MessagingStyle.Message
  • NotificationCompat.Style
  • NotificationCompat.WearableExtender
  • NotificationCompatExtras
  • NotificationCompatSideChannelService
  • NotificationManagerCompat
  • RemoteInput
  • RemoteInput.Builder
  • ServiceCompat
  • ShareCompat
  • ShareCompat.IntentBuilder
  • ShareCompat.IntentReader
  • SharedElementCallback
  • TaskStackBuilder

• Exceptions

  • Fragment.InstantiationException