mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Added documentation for BrowserWindow.setAppDetails

Browse source
This commit is contained in:
Tereza Tomcova 2016-11-18 21:29:04 +01:00
parent 782417b1fa
commit b305020c1d
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/api/browser-window.md
View file

@ -1103,6 +1103,26 @@ the entire window by specifying an empty region:
Sets the toolTip that is displayed when hovering over the window thumbnail Sets the toolTip that is displayed when hovering over the window thumbnail
in the taskbar. 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_ #### `win.showDefinitionForSelection()` _macOS_
Same as `webContents.showDefinitionForSelection()`. Same as `webContents.showDefinitionForSelection()`.