This topic has not yet been rated - Rate this topic

ToastNotifier.RemoveFromSchedule | removeFromSchedule method

Cancels the scheduled display of a specified ScheduledToastNotification.

Important This method cannot be used by desktop callers.

Syntax


toastNotifier.removeFromSchedule(scheduledToast);

Parameters

scheduledToast

Type: ScheduledToastNotification

The notification to remove from the schedule.

Remarks

If you want to cancel one or more scheduled toast notifications, you can use the GetScheduledToastNotifications method to get the full list.

Examples

The following example shows the use of the RemoveFromSchedule method.

JavaScript



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]);
    }
}

Requirements