TileFlyoutNotification
TileFlyoutNotification
TileFlyoutNotification
TileFlyoutNotification
Class
Definition
Provides the details of a tile flyout (mix view) notification. This includes the notification's XML content and, optionally, its expiration time. This class also provides a method by which you can retrieve the current flyout notification's XML content.
This class is part of the following general API usage pattern:
- Call TileFlyoutUpdateManager.GetTemplateContent to retrieve and fill in a blank tile flyout notification XML template
- Call the TileFlyoutNotification constructor to encapsulate the template content as a flyout notification
- Call one of the TileFlyoutUpdateManager methods to create a TileFlyoutUpdater
- Call TileFlyoutUpdater.Update to send the TileFlyoutNotification to the tile
public : sealed class TileFlyoutNotification : ITileFlyoutNotificationpublic sealed class TileFlyoutNotification : ITileFlyoutNotificationPublic NotInheritable Class TileFlyoutNotification Implements ITileFlyoutNotification// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Constructors
TileFlyoutNotification(XmlDocument) TileFlyoutNotification(XmlDocument) TileFlyoutNotification(XmlDocument) TileFlyoutNotification(XmlDocument)
Creates a TileFlyoutNotification object for use in a tile flyout (mix view) notification. This object provides the XML content of the notification— the sub-tiles to be displayed and the text and image elements used in each sub-tile.
public : TileFlyoutNotification(XmlDocument content)public TileFlyoutNotification(XmlDocument content)Public Sub New(content As XmlDocument)// You can use this method in JavaScript.
- content
- XmlDocument XmlDocument XmlDocument XmlDocument
The XML content of the tile flyout notification.
Properties
Content Content Content Content
Gets the XML description of the current tile flyout (mix view) notification. This content can then be examined or manipulated as necessary.
Note
A tile flyout notification always includes the entire flyout. To update any part of the notification, you must resend the entire notification. For instance, to update the content of only one of the flyout's sub-tiles while leaving the rest of the notification unchanged, call this method to get the current XML payload, alter only the attributes of the specific subtile element, and resend the full payload in a new notification.
public : XmlDocument Content { get; }public XmlDocument Content { get; }Public ReadOnly Property Content As XmlDocument// You can use this property in JavaScript.
The XML content of the current tile flyout notification.
ExpirationTime ExpirationTime ExpirationTime ExpirationTime
Gets or sets the time that the system will remove the tile flyout (mix view) notification. By default, a tile flyout notification does not expire. It is generally a best practice to explicitly set an expiration time to avoid stale content.
public : IReference<DateTime> ExpirationTime { get; set; }public Nullable<DateTimeOffset> ExpirationTime { get; set; }Public ReadWrite Property ExpirationTime As Nullable<DateTimeOffset>// You can use this property in JavaScript.
- Value
- IReference<DateTime> Nullable<DateTimeOffset> Nullable<DateTimeOffset> Nullable<DateTimeOffset>
The date and time that the notification should be removed.