TileUpdater.RemoveFromSchedule(ScheduledTileNotification) Method

Definition

Namespace:

Windows.UI.Notifications

Removes an upcoming tile update from the schedule.

public:
 virtual void RemoveFromSchedule(ScheduledTileNotification ^ scheduledTile) = RemoveFromSchedule;

void RemoveFromSchedule(ScheduledTileNotification const& scheduledTile);

public void RemoveFromSchedule(ScheduledTileNotification scheduledTile);

function removeFromSchedule(scheduledTile)

Public Sub RemoveFromSchedule (scheduledTile As ScheduledTileNotification)

Parameters

scheduledTile

ScheduledTileNotification

The notification to remove from the schedule.

Examples

The following example shows the use of the RemoveFromSchedule method.

var notifier = Notifications.TileUpdateManager.createTileUpdaterForApplication();
var scheduled = notifier.getScheduledTileNotifications();

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

See also

• App tiles and badges sample
• Scheduled notifications sample
• Guidelines and checklist for scheduled notifications
• 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