diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 5ff2380a581..339d08724d0 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1103,6 +1103,26 @@ the entire window by specifying an empty region: Sets the toolTip that is displayed when hovering over the window thumbnail in the taskbar. +#### `win.setAppDetails(options)` _Windows_ + +* `options` Object + * `appId` String (optional) - + Window's [App User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd391569(v=vs.85).aspx). + It has to be set, otherwise the other options will have no effect. + * `appIconPath` String (optional) - + Window's [Relaunch Icon](https://msdn.microsoft.com/en-us/library/windows/desktop/dd391573(v=vs.85).aspx). + * `appIconIndex` Integer (optional) - Index of the icon in `appIconPath`. + Ignored when `appIconPath` is not set. Default is `0`. + * `relaunchCommand` String (optional) - + Window's [Relaunch Command](https://msdn.microsoft.com/en-us/library/windows/desktop/dd391571(v=vs.85).aspx). + * `relaunchDisplayName` String (optional) - + Window's [Relaunch Display Name](https://msdn.microsoft.com/en-us/library/windows/desktop/dd391572(v=vs.85).aspx). + +Sets the properties for the window's taskbar button. + +**Note:** `relaunchCommand` and `relaunchDisplayName` must always be set together. If one +of those properties is not set, then neither is used. + #### `win.showDefinitionForSelection()` _macOS_ Same as `webContents.showDefinitionForSelection()`.