TileUpdater.EnableNotificationQueue | enableNotificationQueue method

Applies to Windows and Windows Phone

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

Syntax


public:
void EnableNotificationQueue(
  bool enable
)

Parameters

enable

Type: Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

True to enable queuing; otherwise false.

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.

Examples

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



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

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.UI.Notifications
Windows::UI::Notifications [C++]

Metadata

Windows.winmd

See also

TileUpdater
How to use the notification queue with local notifications
App tiles and badges sample
Quickstart: Sending a tile update
Tile and tile notification overview
The tile template catalog
Guidelines and checklist for tiles
How to schedule a tile notification
How to set up periodic notifications for tiles
Tiles XML schema

 

 

Show:
© 2014 Microsoft. All rights reserved.