Microsoft Band Web Tile

Microsoft Band Web Tile manifest file

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/microsoft-band-web-tile/latest.json
Source https://www.schemastore.org/band-manifest.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

manifestVersion enum required

Defines the contract between the web tile developer and the Microsoft Health app. It must be set to 1 for the current release.

Values: 1
name string required

Defines the name of the web tile.

maxLength=21
tileIcon object required

Specifies the location of the large tile icon.

1 nested properties
46 string required
pattern=\.png$
resources resource[] required

Each web tile must refer to one or more web resources. Each resource object describes a web data from which content for the tile will be extracted.

pages page[] required

Each tile consists of one or more pages, as described by the objects in this array. Each page object specifies the layout and content of the page.

description string

Provides description about the web tile.

maxLength=100
version number

Indicates the version number of the web tile which will not be shown to users.

versionString string

Indicates the web tile version as shown to users. If not provided, it displays the version.

maxLength=10
author string

Specifies the author of the web tile.

maxLength=50
organization string

Specifies the organization associated with the web tile.

maxLength=100
contactEmail string

Provides contact info of the web tile author. Used for administrative purposes and analytics by Microsoft Band team.

format=emailmaxLength=100
badgeIcon object

Specifies the location of the small tile icon. If not provided, the badging functionality is not enabled.

1 nested properties
24 string required
pattern=\.png$
tileTheme object

Specifies the custom theme colors for the web tile.

6 nested properties
base string

The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

pattern=^[A-Fa-f0-9]{6}$
highlight string

The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

pattern=^[A-Fa-f0-9]{6}$
lowlight string

The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

pattern=^[A-Fa-f0-9]{6}$
secondary string

The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

pattern=^[A-Fa-f0-9]{6}$
highcontrast string

The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

pattern=^[A-Fa-f0-9]{6}$
muted string

The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

pattern=^[A-Fa-f0-9]{6}$
refreshIntervalMinutes integer

Specifies the desired data refresh interval, in minutes. Refresh intervals shorter than 15 will not be honored. If not provided, it defaults to 30.

Default: 30
min=15
icons Record<string, string>

All PNG icons used by the tile within its pages must be provided here.

notifications notification[]

Creates notification that gets delivered when certain conditions are detected in the new web data.

Definitions

icon string
color string

The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

elementId enum

The numeric id of the icon layout element based on the predefined layout selected.

condition enum

If set, then must be set to 'true' for this release

resource object
url string required

The URL to be referenced. For resources that require authentication, the URL must be HTTPS.

format=uri
style string required

Specifies the kind of web resource being accessed. Permitted values are 'Simple' and 'Feed'.

Default: "Simple"
pattern=^([sS]imple|[fF]eed)$
content Record<string, string> required

This member specifies how to extract content from the web response.

page object
layout enum required

The name of the layout for the page. The layout name should refer to one of the predefined page layouts.

Values: "MSBand_ScrollingText" "MSBand_NoScrollingText" "MSBand_SingleMetric" "MSBand_SingleMetricWithIcon" "MSBand_MetricsWithIcons" "MSBand_SingleMetricWithSecondary"
condition enum

If set, then must be set to 'true' for this release

Values: "true"
iconBindings iconBinding[]

Similar to textBindings, but used to select one of the web tile icons in icons list for each icon in the page. If there are no icon elements on the page, this member may be omitted.

minItems=1
textBindings textBinding[]

An array of objects corresponding to each page element that contains string content. Each binding object provides the numeric id of the page element based on the predefined layout selected, and the string value that it should contain.

minItems=1
iconBinding object
elementId enum required

The numeric id of the icon layout element based on the predefined layout selected.

Values: "1" "2" "3" "11" "12" "21" "22" "31" "32"
conditions object[] required

For this release, this must contain an array with a single 'condition' object whose 'condition' is true, and whose 'icon' member specifies the name of the icon to be used.

textBinding object
elementId enum required

The numeric id of the icon layout element based on the predefined layout selected.

Values: "1" "2" "3" "11" "12" "21" "22" "31" "32"
value string required
notification object
condition string required

The condition to be evaluated to determine whether to trigger the notification. The conditional expression has the syntax ' ' or 'true'.

title string required

The text to use for the notification title. If longer than 20 characters, it will be truncated.

body string

The text to use for the notification body. If longer than 20 characters, it will be truncated.