TileUpdater Classe

Définition

Espace de noms:

Windows.UI.Notifications

Modifie le contenu de la vignette spécifique à laquelle la mise à jour est liée.

public ref class TileUpdater sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class TileUpdater final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class TileUpdater

Public NotInheritable Class TileUpdater

Héritage

Object Platform::Object IInspectable TileUpdater

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

L’exemple suivant montre La mise à jour utilisée pour envoyer une notification à la vignette de l’application.

function sendTileTextNotification() {
    var Notifications = Windows.UI.Notifications;

    // Get an XML DOM version of a specific template by using getTemplateContent.
    var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text03);

    // You will need to look at the template documentation to know how many text fields a particular template has.
    // Get the text attribute for this template and fill it in.
    var tileAttributes = tileXml.getElementsByTagName("text");
    tileAttributes[0].appendChild(tileXml.createTextNode("Hello World!"));

    // Create the notification from the XML.
    var tileNotification = new Notifications.TileNotification(tileXml);

    // Send the notification to the calling app's tile.
    Notifications.TileUpdateManager.createTileUpdaterForApplication().update(tileNotification);
}

La ligne de code suivante utilise EnableNotificationQueue pour activer la file d’attente de notification pour la vignette de l’application appelante.

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

L’exemple suivant montre l’utilisation de la méthode RemoveFromSchedule .

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

Remarques

Pour obtenir une instance de cet objet, appelez la méthode TileUpdateManager.CreateTileUpdaterForApplication ou TileUpdateManager.CreateTileUpdaterForSecondaryTile.

Lorsqu’il est créé, TileUpdater est lié à une application ou à une vignette secondaire spécifique, de sorte que les méthodes de cette classe affectent uniquement la vignette unique à laquelle l’objet instance est lié.

Propriétés

Setting

Obtient une valeur qui spécifie si une vignette peut être mise à jour via des notifications.

Méthodes

AddToSchedule(ScheduledTileNotification)	Ajoute une valeur ScheduledTileNotification à la planification.
Clear()	Supprime toutes les mises à jour et oblige la vignette à afficher son contenu par défaut comme déclaré dans le manifeste de l’application.
EnableNotificationQueue(Boolean)	Permet à la vignette de mettre en file d’attente jusqu’à cinq notifications. Cela active la file d’attente de notification sur toutes les tailles de vignette.
EnableNotificationQueueForSquare150x150(Boolean)	Permet à la vignette de mettre en file d’attente jusqu’à cinq notifications sur la vignette moyenne.
EnableNotificationQueueForSquare310x310(Boolean)	Permet à la vignette de mettre en file d’attente jusqu’à cinq notifications sur la grande vignette.
EnableNotificationQueueForWide310x150(Boolean)	Permet à la vignette de mettre en file d’attente jusqu’à cinq notifications sur la vignette large.
GetScheduledTileNotifications()	Récupère la liste des mises à jour planifiées de la vignette.
RemoveFromSchedule(ScheduledTileNotification)	Supprime une prochaine mise à jour de vignette de la planification.
StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)	Commence une série de mises à jour chronologiques pour la vignette à laquelle l’éditeur de mise à jour est lié. Le contenu de mise à jour est récupéré à partir d’un URI (Uniform Resource Identifier) spécifié. Mises à jour commencer à une heure spécifiée.
StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence)	Commence une série de modifications de contenu chronopliquées pour la vignette à laquelle la mise à jour est liée, commençant immédiatement.
StartPeriodicUpdateBatch(IIterable<Uri>, DateTime, PeriodicUpdateRecurrence)	Commence une série de mises à jour chrono timelées qui s’exécutent sur la vignette à laquelle le programme de mise à jour est lié. Le contenu de la mise à jour est récupéré à partir d’un tableau d’URI (Uniform Resource Identifier) spécifié, les mises à jour commençant à une heure spécifiée et les mises à jour suivantes se produisant à l’intervalle périodique suivant. Notes Pour utiliser cette fonctionnalité, vous devez d’abord activer la file d’attente de notification de la vignette en appelant EnableNotificationQueue.
StartPeriodicUpdateBatch(IIterable<Uri>, PeriodicUpdateRecurrence)	Commence une série de mises à jour chrono timelées qui s’exécutent sur la vignette à laquelle le programme de mise à jour est lié. Le contenu de la mise à jour est récupéré à partir d’un tableau d’URI (Uniform Resource Identifier) spécifié, la première mise à jour se produisant immédiatement et les mises à jour suivantes se produisent à intervalles périodiques par la suite. Notes Pour utiliser cette fonctionnalité, vous devez d’abord activer la file d’attente de notification de la vignette en appelant EnableNotificationQueue.
StopPeriodicUpdate()	Annule la série actuelle de mises à jour chronométriques pour la vignette à laquelle la mise à jour est liée.
Update(TileNotification)	Applique une modification du contenu ou de l’apparence à la vignette.