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

Tweak setAppDetails docs

Browse source
This commit is contained in:
Kevin Sawicki 2016-11-28 14:29:21 -08:00
parent fff59271af
commit 5abecadfd3
1 changed files with 6 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1106,22 +1106,18 @@ in the taskbar.
#### `win.setAppDetails(options)` _Windows_ #### `win.setAppDetails(options)` _Windows_
* `options` Object * `options` Object
* `appId` String (optional) - * `appId` String (optional) - Window's [App User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd391569(v=vs.85).aspx).
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. It has to be set, otherwise the other options will have no effect.
* `appIconPath` String (optional) - * `appIconPath` String (optional) - Window's [Relaunch Icon](https://msdn.microsoft.com/en-us/library/windows/desktop/dd391573(v=vs.85).aspx).
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`. * `appIconIndex` Integer (optional) - Index of the icon in `appIconPath`.
Ignored when `appIconPath` is not set. Default is `0`. Ignored when `appIconPath` is not set. Default is `0`.
* `relaunchCommand` String (optional) - * `relaunchCommand` String (optional) - Window's [Relaunch Command](https://msdn.microsoft.com/en-us/library/windows/desktop/dd391571(v=vs.85).aspx).
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).
* `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. Sets the properties for the window's taskbar button.
**Note:** `relaunchCommand` and `relaunchDisplayName` must always be set together. If one **Note:** `relaunchCommand` and `relaunchDisplayName` must always be set
of those properties is not set, then neither is used. together. If one of those properties is not set, then neither will be used.
#### `win.showDefinitionForSelection()` _macOS_ #### `win.showDefinitionForSelection()` _macOS_