Functions
The Live Tiles API contains the following functions, which are part of the voltmx.application Namespace.
voltmx.application.setAppTile
This API enables you to set the data for an application tile. If the user chooses to pin the application tile, the data set is visible. For more information on pinning a tile, refer https://answers.microsoft.com/en-us/windows/forum/all/deleting-and-moving-tiles-from-the-start-screen.
Syntax
voltmx.application.setAppTitle([tileTemplateType](#tileTemplateType), [tileTemplateData](#tileTemplateData))
setapptile([tileTemplateType](#tileTemplateType), [tileTemplateData](#tileTemplateData))
Input Parameters for Windows 10
| Parameter | Description |
|---|---|
| tileTemplateType [String] - Mandatory | tileTemplateType is a string describing which tile template to use. Refer the tile template catalog for the list of supported tile templates |
| tileTemplateData [Array] - Optional | tileTemplateData is an array of data for the tile, according to the tileTemplateType being used. The tile template catalog. contains details of the data required for each tile template. |
Example
voltmx.application.setAppTile("TileSquareBlock", ["Hello", "World!"] );
Return Values
None
UI Behavior - Windows 10
The title and the display name of the tile will be displayed in white or black depending on the setting in Volt MX Iris and this behavior cannot be changed even if the user sets a different theme or a background image. Unlike Mango, tiles cannot be flipped on Windows 10. The tile can be updated dynamically in Windows 10.
Platform Availability
Available on Windows.
voltmx.application.setSecondaryTile
This function enables you to create or update data for a secondary tile for an application. For more information about secondary tiles, refer Secondary tiles.
Syntax
voltmx.application.setSecondaryTile([id](#id2), [shortname](#title), [displayname](#displayname), [imagename](#imagename))
setSecondaryTile([id](#id2), [shortname](#title), [displayname](#displayname), [imagename](#imagename))
Input Parameters for Windows 10
| Parameter | Description |
|---|---|
| id [String] - Mandatory | Unique identifier of the secondary tile. |
| shortname [String] - Mandatory | A short name displayed directly on the tile. Anything over 40 characters will be truncated. The user has the option to change this value as part of the pinning process. |
| displayname[String] - Optional | The text specified here is displayed when you hover over the tile. There is no restriction on the display name length or the characters that it can contain. |
| imagename [String] - Optional | Name of the image to be displayed on the tile. |
Example
//Setting a secondary tile for an application with tile id myTile1.
voltmx.application.setSecondaryTile("myTile1", "title text", "display name", "orange.png");
Return Values
None
UI Behavior - Windows 10
The title and the display name of the tile will be displayed in white or black depending on the setting in Volt MX Iris and this behavior cannot be changed even if the user sets a different theme or a background image. Unlike Mango, tiles cannot be flipped on Windows 10. The tile can be updated dynamically in Windows 10.
Platform Availability
Available for Windows.
voltmx.application.removeSecondaryTile
This API enables you to remove and unpin a specified secondary tile which was created earlier.
Syntax
voltmx.application.removeSecondaryTile([id](#id2))
Input Parameters
| Parameter | Description |
|---|---|
| id [String] - Mandatory | Unique identifier of the secondary tile |
Example
voltmx.application.removeSecondaryTile("12345");
Return Values
None
Platform Availability
Available on Windows.
