API reference
Pinned sites support a variety of events, methods, and properties.
For a list of supported metadata values, see Metadata reference.
For Pinned site tutorials and walkthroughs, see Pinned site developer documentation
In this section
| Topic | Description |
|---|---|
Creates a pinned site shortcut to the current webpage on the Windows Start menu. This method is only supported in Internet Explorer 11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Removes notifications from a tile. |
|
Controls notification cycling for a tile. |
|
Controls notification cycling for medium (150x150) tiles. |
|
Controls notification cycling for large (310x310) tiles. |
|
Controls notification cycling for wide (310x150) tiles. |
|
Determines whether the current page was launched as a pinned site. This method is only supported in IE11 on Windows 10. |
|
Determines whether a pinned site was launched for the first time. This method is only supported in IE11 on Windows 10. |
|
Indicates if the site is pinned, not pinned, or pinned with live tiles turned off. This method will be supported in Microsoft Edge on Windows 10 in a future update. |
|
Removes a previously-scheduled notification. This method will only be supported in Microsoft Edge on Windows 10 in a future update. |
|
Defines one or more non-recurring, scheduled updates. This method is only supported in Microsoft Edge on Windows 10. |
|
Flashes the pinned site taskbar button. This method is only supported in IE11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Defines an alternate icon image and tooltip for the specified button. This method is only supported in IE11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Adds a new entry to the Jump List of a taskbar button. This method is only supported in IE11 on Windows 10. |
|
Adds a button to the Thumbnail Toolbar. This method is only supported in IE11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Clears the notifications on a pinned site badge in Windows 8. |
|
Removes the icon overlay from the taskbar button. This method is only supported in IE11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Deletes the Jump List. This method is only supported in IE11 on Windows 10. |
|
Creates a new group of items on the Jump List. This method is only supported in IE11 on Windows 10. |
|
Causes Windows 8 to refresh the site tile badge for a webpage to be sure that it is up to date. |
|
Adds an icon overlay to the pinned site taskbar button. This method is only supported in IE11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Changes the icon image and tooltip of a Thumbnail Toolbar button. This method is only supported in IE11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Shows updates to the list of items in a Jump List. This method is only supported in IE11 on Windows 10. |
|
Enables the Thumbnail Toolbar in the thumbnail preview of a pinned site. This method is only supported in IE11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Changes the state of a Thumbnail Toolbar button. This method is only supported in IE11 on Windows 10. This method is not supported for Windows Store apps using JavaScript. |
|
Fires when a site is pinned to the Start screen. |
|
Starts a badge update for a tile. This method is only supported in Microsoft Edge on Windows 10. |
|
Starts a periodic update for a tile. This method is only supported in Microsoft Edge on Windows 10. |
|
Starts a set of periodic updates for a tile. This method is only supported in Microsoft Edge on Windows 10. |
|
Cancels the currently schedule batch of timed badge updates for a tile. This method is only supported in Microsoft Edge on Windows 10. |
|
Cancels the currently schedule batch of timed tiles updates. This method is only supported in Microsoft Edge on Windows 10. |