ToastNotifier.GetScheduledToastNotifications Method

Definition

Namespace:

Windows.UI.Notifications

Gets the collection of ScheduledToastNotification objects that this app has scheduled for display.

Important

This method is only supported in applications which use WinRT as their default application framework.

public:
 virtual IVectorView<ScheduledToastNotification ^> ^ GetScheduledToastNotifications() = GetScheduledToastNotifications;

IVectorView<ScheduledToastNotification> GetScheduledToastNotifications();

public IReadOnlyList<ScheduledToastNotification> GetScheduledToastNotifications();

function getScheduledToastNotifications()

Public Function GetScheduledToastNotifications () As IReadOnlyList(Of ScheduledToastNotification)

Returns

IVectorView<ScheduledToastNotification>

IReadOnlyList<ScheduledToastNotification>

The collection of scheduled toast notifications that the app bound to this notifier has scheduled for timed display.

Examples

The following example shows the use of the GetScheduledToastNotifications method.

var notifier = Notifications.ToastNotificationManager.createToastNotifier();
var scheduled = notifier.getScheduledToastNotifications();                    

for (var i = 0, len = scheduled.length; i < len; i++) {

    // The itemId value is the unique ScheduledTileNotification.Id assigned to the 
    // notification when it was created.
    if (scheduled[i].id === itemId) {
        notifier.removeFromSchedule(scheduled[i]);
    }
}