TileFlyoutUpdater
TileFlyoutUpdater
TileFlyoutUpdater
TileFlyoutUpdater
Class
Definition
Used to send or clear a tile flyout (mix view) notification. This class also provides methods to start and stop periodic tile flyout notifications.
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 TileFlyoutUpdater : ITileFlyoutUpdaterpublic sealed class TileFlyoutUpdater : ITileFlyoutUpdaterPublic NotInheritable Class TileFlyoutUpdater Implements ITileFlyoutUpdater// 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)
|
Properties
Setting Setting Setting Setting
Gets a value that specifies whether a tile's flyout can be updated through notifications.
public : NotificationSetting Setting { get; }public NotificationSetting Setting { get; }Public ReadOnly Property Setting As NotificationSetting// You can use this property in JavaScript.
This value always returns Enabled. Mix view cannot currently be disabled.
Methods
Clear() Clear() Clear() Clear()
Removes the current tile flyout (mix view) notification. A tile flyout notification does not have a default expiration time, so unless one is set explicitly through TileFlyoutNotification.ExpirationTime, this method is the only way to remove the flyout.
public : void Clear()public void Clear()Public Function Clear() As void// You can use this method in JavaScript.
StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence) StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence) StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence) StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)
Launches a series of periodic updates for a tile flyout (mix view) notification, beginning at a specified time. Update content is retrieved from a specified Uniform Resource Identifier (URI).
public : void StartPeriodicUpdate(Uri tileFlyoutContent, DateTime startTime, PeriodicUpdateRecurrence requestedInterval)public void StartPeriodicUpdate(Uri tileFlyoutContent, DateTimeOffset startTime, PeriodicUpdateRecurrence requestedInterval)Public Function StartPeriodicUpdate(tileFlyoutContent As Uri, startTime As DateTimeOffset, requestedInterval As PeriodicUpdateRecurrence) As void// You can use this method in JavaScript.
- tileFlyoutContent
- Uri Uri Uri Uri
The Uniform Resource Identifier (URI) from which the XML content of the tile flyout update is retrieved.
- startTime
- DateTime DateTimeOffset DateTimeOffset DateTimeOffset
The date and time at which the Uniform Resource Identifier (URI) should first be polled for new content.
- requestedInterval
- PeriodicUpdateRecurrence PeriodicUpdateRecurrence PeriodicUpdateRecurrence PeriodicUpdateRecurrence
The frequency with which the Uniform Resource Identifier (URI) is polled for new content, following the initial update at startTime.
- See Also
StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence) StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence) StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence) StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence)
Launches a series of periodic updates for a tile flyout (mix view) notification, beginning with an immediate update when the method is called. Update content is retrieved from a specified Uniform Resource Identifier (URI).
public : void StartPeriodicUpdate(Uri tileFlyoutContent, PeriodicUpdateRecurrence requestedInterval)public void StartPeriodicUpdate(Uri tileFlyoutContent, PeriodicUpdateRecurrence requestedInterval)Public Function StartPeriodicUpdate(tileFlyoutContent As Uri, requestedInterval As PeriodicUpdateRecurrence) As void// You can use this method in JavaScript.
- tileFlyoutContent
- Uri Uri Uri Uri
The Uniform Resource Identifier (URI) from which the XML content of the tile flyout update is retrieved.
- requestedInterval
- PeriodicUpdateRecurrence PeriodicUpdateRecurrence PeriodicUpdateRecurrence PeriodicUpdateRecurrence
The frequency with which the Uniform Resource Identifier (URI) is polled for new content, following the initial update.
- See Also
StopPeriodicUpdate() StopPeriodicUpdate() StopPeriodicUpdate() StopPeriodicUpdate()
Cancels the current series of periodic tile flyout (mix view) notification updates for the primary or secondary tile associated with the updater.
public : void StopPeriodicUpdate()public void StopPeriodicUpdate()Public Function StopPeriodicUpdate() As void// You can use this method in JavaScript.
Update(TileFlyoutNotification) Update(TileFlyoutNotification) Update(TileFlyoutNotification) Update(TileFlyoutNotification)
Sends a new tile flyout (mix view) notification to the primary or secondary tile associated with the updater.
Note
Sending a tile flyout notification to a device that does not support hover causes an exception to be thrown. Always verify the device's hover capability before you call this method.
public : void Update(TileFlyoutNotification notification)public void Update(TileFlyoutNotification notification)Public Function Update(notification As TileFlyoutNotification) As void// You can use this method in JavaScript.
- notification
- TileFlyoutNotification TileFlyoutNotification TileFlyoutNotification TileFlyoutNotification
The notification object that supplies the new content for the tile's flyout.