Package org.robolectric.shadows

Class ShadowNotificationManager

java.lang.Object

org.robolectric.shadows.ShadowNotificationManager

@Implements(android.app.NotificationManager.class)
public class ShadowNotificationManager
extends Object

Shadows for NotificationManager.

Constructor Summary

Constructors

Constructor	Description
ShadowNotificationManager()

Method Summary

Modifier and Type	Method	Description
protected String	addAutomaticZenRule(AutomaticZenRule automaticZenRule)
protected boolean	areNotificationsEnabled()
protected void	cancel(int id)
protected void	cancel(String tag, int id)
protected void	cancelAll()
protected boolean	canNotifyAsPackage(String pkg)
protected void	createNotificationChannel(NotificationChannel channel)
protected void	createNotificationChannelGroup(NotificationChannelGroup group)
protected void	createNotificationChannelGroups(List<NotificationChannelGroup> groupList)
protected void	createNotificationChannels(List<NotificationChannel> channelList)
protected void	deleteNotificationChannel(String channelId)
protected void	deleteNotificationChannelGroup(String channelGroupId)	Delete a notification channel group and all notification channels associated with the group.
StatusBarNotification[]	getActiveNotifications()
List<Notification>	getAllNotifications()
protected AutomaticZenRule	getAutomaticZenRule(String id)
protected Map<String,AutomaticZenRule>	getAutomaticZenRules()
protected NotificationManager.Policy	getConsolidatedNotificationPolicy()
protected int	getCurrentInterruptionFilter()
protected int	getImportance()
Notification	getNotification(int id)
Notification	getNotification(String tag, int id)
protected NotificationChannel	getNotificationChannel(String channelId)
protected NotificationChannel	getNotificationChannel(String channelId, String conversationId)	Returns a NotificationChannel that has the given parent and conversation ID.
NotificationChannelGroup	getNotificationChannelGroup(String id)
protected List<NotificationChannelGroup>	getNotificationChannelGroups()
List<NotificationChannel>	getNotificationChannels()
protected String	getNotificationDelegate()
protected NotificationManager.Policy	getNotificationPolicy()
boolean	isChannelDeleted(String channelId)	Checks whether a channel is considered a "deleted" channel by Android.
protected boolean	isNotificationListenerAccessGranted(ComponentName componentName)
protected boolean	isNotificationPolicyAccessGranted()
protected void	notify(int id, Notification notification)
protected void	notify(String tag, int id, Notification notification)
protected boolean	removeAutomaticZenRule(String id)
static void	reset()
void	setCanNotifyAsPackage(String otherPackage, boolean canNotify)	Sets notification delegate for the package provided.
void	setConsolidatedNotificationPolicy(NotificationManager.Policy policy)	Specifies the consolidated notification policy to return
void	setEnforceMaxNotificationLimit(boolean enforceMaxNotificationLimit)	Ensures a notification limit is applied before posting the notification.
void	setImportance(int importance)
protected void	setInterruptionFilter(int interruptionFilter)	Currently does not support checking for granted policy access.
protected void	setNotificationDelegate(String delegate)
void	setNotificationListenerAccessGranted(ComponentName componentName, boolean granted)	Sets the value returned by NotificationManager.isNotificationListenerAccessGranted(ComponentName) for the provided ComponentName.
protected void	setNotificationPolicy(NotificationManager.Policy policy)	Currently does not support checking for granted policy access.
void	setNotificationPolicyAccessGranted(boolean granted)	Sets the value returned by NotificationManager.isNotificationPolicyAccessGranted().
void	setNotificationsEnabled(boolean areNotificationsEnabled)
int	size()
protected boolean	updateAutomaticZenRule(String id, AutomaticZenRule automaticZenRule)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShadowNotificationManager

public ShadowNotificationManager()

Method Details

reset

@Resetter
public static void reset()

notify

@Implementation
protected void notify(int id,
 Notification notification)

notify

@Implementation
protected void notify(String tag,
 int id,
 Notification notification)

cancel

@Implementation
protected void cancel(int id)

cancel

@Implementation
protected void cancel(String tag,
 int id)

cancelAll

@Implementation
protected void cancelAll()

areNotificationsEnabled

@Implementation(minSdk=24)
protected boolean areNotificationsEnabled()

setNotificationsEnabled

public void setNotificationsEnabled(boolean areNotificationsEnabled)

getImportance

@Implementation(minSdk=24)
protected int getImportance()

setImportance

public void setImportance(int importance)

getActiveNotifications

@Implementation(minSdk=23)
public StatusBarNotification[] getActiveNotifications()

getNotificationChannel

@Implementation(minSdk=26)
protected NotificationChannel getNotificationChannel(String channelId)

getNotificationChannel

@Implementation(minSdk=30)
protected NotificationChannel getNotificationChannel(String channelId,
 String conversationId)

Returns a NotificationChannel that has the given parent and conversation ID.

createNotificationChannelGroup

@Implementation(minSdk=26)
protected void createNotificationChannelGroup(NotificationChannelGroup group)

createNotificationChannelGroups

@Implementation(minSdk=26)
protected void createNotificationChannelGroups(List<NotificationChannelGroup> groupList)

getNotificationChannelGroups

@Implementation(minSdk=26)
protected List<NotificationChannelGroup> getNotificationChannelGroups()

createNotificationChannel

@Implementation(minSdk=26)
protected void createNotificationChannel(NotificationChannel channel)

createNotificationChannels

@Implementation(minSdk=26)
protected void createNotificationChannels(List<NotificationChannel> channelList)

getNotificationChannels

@Implementation(minSdk=26)
public List<NotificationChannel> getNotificationChannels()

deleteNotificationChannel

@Implementation(minSdk=26)
protected void deleteNotificationChannel(String channelId)

deleteNotificationChannelGroup

@Implementation(minSdk=26)
protected void deleteNotificationChannelGroup(String channelGroupId)

Delete a notification channel group and all notification channels associated with the group. This method will not notify any NotificationListenerService of resulting changes to notification channel groups nor to notification channels.

getCurrentInterruptionFilter

@Implementation(minSdk=23)
protected int getCurrentInterruptionFilter()

Returns:

NotificationManager.INTERRUPTION_FILTER_ALL by default, or the value specified via setInterruptionFilter(int)

setInterruptionFilter

@Implementation(minSdk=23)
protected void setInterruptionFilter(int interruptionFilter)

Currently does not support checking for granted policy access.

See Also:

• NotificationManager.getCurrentInterruptionFilter()

getNotificationPolicy

@Implementation(minSdk=23)
protected NotificationManager.Policy getNotificationPolicy()

Returns:

the value specified via setNotificationPolicy(Policy)

setConsolidatedNotificationPolicy

public void setConsolidatedNotificationPolicy(NotificationManager.Policy policy)

Specifies the consolidated notification policy to return

See Also:

• getConsolidatedNotificationPolicy()

getConsolidatedNotificationPolicy

@Implementation(minSdk=30)
protected NotificationManager.Policy getConsolidatedNotificationPolicy()

Returns:

the value specified via setConsolidatedNotificationPolicy(Policy)

isNotificationPolicyAccessGranted

@Implementation(minSdk=23)
protected boolean isNotificationPolicyAccessGranted()

Returns:

the value specified via setNotificationPolicyAccessGranted(boolean)

isNotificationListenerAccessGranted

@Implementation(minSdk=27)
protected boolean isNotificationListenerAccessGranted(ComponentName componentName)

Returns:

the value specified for the given ComponentName via setNotificationListenerAccessGranted(ComponentName, boolean) or false if unset.

setNotificationPolicy

@Implementation(minSdk=23)
protected void setNotificationPolicy(NotificationManager.Policy policy)

Currently does not support checking for granted policy access.

See Also:

• NotificationManager.getNotificationPolicy()

setNotificationPolicyAccessGranted

public void setNotificationPolicyAccessGranted(boolean granted)

Sets the value returned by NotificationManager.isNotificationPolicyAccessGranted(). If granted is false, this also deletes all AutomaticZenRules.

See Also:

• NotificationManager.isNotificationPolicyAccessGranted()

setNotificationListenerAccessGranted

@Implementation(minSdk=27)
public void setNotificationListenerAccessGranted(ComponentName componentName,
 boolean granted)

Sets the value returned by NotificationManager.isNotificationListenerAccessGranted(ComponentName) for the provided ComponentName.

getAutomaticZenRule

@Implementation(minSdk=24)
protected AutomaticZenRule getAutomaticZenRule(String id)

getAutomaticZenRules

@Implementation(minSdk=24)
protected Map<String,AutomaticZenRule> getAutomaticZenRules()

addAutomaticZenRule

@Implementation(minSdk=24)
protected String addAutomaticZenRule(AutomaticZenRule automaticZenRule)

updateAutomaticZenRule

@Implementation(minSdk=24)
protected boolean updateAutomaticZenRule(String id,
 AutomaticZenRule automaticZenRule)

removeAutomaticZenRule

@Implementation(minSdk=24)
protected boolean removeAutomaticZenRule(String id)

getNotificationDelegate

@Implementation(minSdk=29)
protected String getNotificationDelegate()

canNotifyAsPackage

@Implementation(minSdk=29)
protected boolean canNotifyAsPackage(String pkg)

setCanNotifyAsPackage

public void setCanNotifyAsPackage(String otherPackage,
 boolean canNotify)

Sets notification delegate for the package provided.

canNotifyAsPackage(String) will be returned based on this value.

Parameters:

otherPackage - the package for which the current package can notify on behalf

canNotify - whether the current package is set as notification delegate for 'otherPackage'

setNotificationDelegate

@Implementation(minSdk=29)
protected void setNotificationDelegate(String delegate)

setEnforceMaxNotificationLimit

public void setEnforceMaxNotificationLimit(boolean enforceMaxNotificationLimit)

Ensures a notification limit is applied before posting the notification.

When set to true a maximum notification limit of 25 is applied. Notifications past this limit are dropped and are not posted or enqueued.

When set to false no limit is applied and all notifications are posted or enqueued. This is the default behavior.

isChannelDeleted

public boolean isChannelDeleted(String channelId)

Checks whether a channel is considered a "deleted" channel by Android. This is a channel that was created but later deleted. If a channel is created that was deleted before, it recreates the channel with the old settings.

getNotificationChannelGroup

@Implementation(minSdk=28)
public NotificationChannelGroup getNotificationChannelGroup(String id)

size

public int size()

getNotification

public Notification getNotification(int id)

getNotification

public Notification getNotification(String tag,
 int id)

getAllNotifications

public List<Notification> getAllNotifications()