SecondaryTile.UpdateAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Updates a secondary tile after that tile is pinned to the Start screen.
On Windows Phone 8.1, your app is suspended and the user is taken to the Start screen when a secondary tile is pinned. Therefore, be aware that any code called after RequestCreateAsync is not guaranteed to be run before the app is suspended. To avoid this potential issue you should use the OnSuspended event of your app to run any code, such as updating the pinned tile, that should be run before the app suspends. To see an example of this pattern, download and run the Tile update on suspend sample.
public:
virtual IAsyncOperation<bool> ^ UpdateAsync() = UpdateAsync;/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> UpdateAsync();[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> UpdateAsync();function updateAsync()Public Function UpdateAsync () As IAsyncOperation(Of Boolean)Returns
An object used to launch the asynchronous create operation as well as to retrieve information about it.
- Attributes
Remarks
This method updates the following properties of the secondary tile:
- DisplayName
- SecondaryTile.Arguments
- SecondaryTile.LockScreenBadgeLogo
- SecondaryTile.LockScreenDisplayBadgeAndTileText
- SecondaryTile.RoamingEnabled
- SecondaryTileVisualElements.BackgroundColor
- SecondaryTileVisualElements.ForegroundText
- SecondaryTileVisualElements.ShowNameOnSquare150x150Logo
- SecondaryTileVisualElements.ShowNameOnSquare310x310Logo
- SecondaryTileVisualElements.ShowNameOnWide310x150Logo
- SecondaryTileVisualElements.Square30x30Logo
- SecondaryTileVisualElements.Square70x70Logo
- SecondaryTileVisualElements.Square150x150Logo
- SecondaryTileVisualElements.Square310x310Logo
- SecondaryTileVisualElements.Wide310x150Logo
- TileId
On Windows 8 and Windows 8.1, this method doesn't update these properties:
If the TileId property is not set before you call this method, the call will raise an exception.