Share via

TileUpdater.EnableNotificationQueue(Boolean) Method

  • Reference

Definition

Namespace:
Windows.UI.Notifications
Edit

Enables the tile to queue up to five notifications. This enables the notification queue on all tile sizes.

public:
 virtual void EnableNotificationQueue(bool enable) = EnableNotificationQueue;
void EnableNotificationQueue(bool const& enable);
public void EnableNotificationQueue(bool enable);
function enableNotificationQueue(enable)
Public Sub EnableNotificationQueue (enable As Boolean)

Parameters

enable
Boolean

bool

True to enable queuing; otherwise false.

Examples

The following line of code enables the notification queue for the calling app's tile.

Windows.UI.Notifications.TileUpdateManager.createTileUpdaterForApplication().enableNotificationQueue(true);

Remarks

When queuing is enabled, a maximum of five tile notifications can automatically cycle on the tile. Be careful about enabling cycling unless your app explicitly wants to use it, otherwise you can potentially have outdated notifications cycling through. Generally, the queue is FIFO (first in, first out), so that when it is full and a new notification arrives, the oldest notification is removed. However, notifications can be given a Tag, which allows a new notification with that same Tag to replace its older notification in the queue, regardless of its position.

When your tile is based on a peek template, notification cycling is timed so that the full content is always shown before the tile cycles to the next notification.

As of Windows 8.1, you can also enable the notification queue for only specific tile sizes. See the following topics:

We recommend that you disable the notification queu when using a large tile with one of the following templates, which already show three notifications simultaneously. This avoids a tile that's distractingly busy to the user. In that case, you may want to use the size-specific enable methods instead of EnableNotificationQueue.

Applies to

See also