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

Standardize shell

Browse source
This commit is contained in:
Jessica Lord 2015-08-28 22:28:30 -07:00
parent 609961a1de
commit a2cc936a3b
1 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/api/shell.md
View file

@ -2,38 +2,43 @@
The `shell` module provides functions related to desktop integration. The `shell` module provides functions related to desktop integration.
An example of opening a URL in default browser: An example of opening a URL in the user's default browser:
```javascript ```javascript
var shell = require('shell'); var shell = require('shell');
shell.openExternal('https://github.com'); shell.openExternal('https://github.com');
``` ```
## shell.showItemInFolder(fullPath) ## Methods
The `shell` module has the following methods:
### `shell.showItemInFolder(fullPath)`
* `fullPath` String * `fullPath` String
Show the given file in a file manager. If possible, select the file. Show the given file in a file manager. If possible, select the file.
## shell.openItem(fullPath) ### `shell.openItem(fullPath)`
* `fullPath` String * `fullPath` String
Open the given file in the desktop's default manner. Open the given file in the desktop's default manner.
## shell.openExternal(url) ### `shell.openExternal(url)`
* `url` String * `url` String
Open the given external protocol URL in the desktop's default manner. (For Open the given external protocol URL in the desktop's default manner. (For
example, mailto: URLs in the default mail user agent.) example, mailto: URLs in the user's default mail agent.)
## shell.moveItemToTrash(fullPath) ### `shell.moveItemToTrash(fullPath)`
* `fullPath` String * `fullPath` String
Move the given file to trash and returns boolean status for the operation. Move the given file to trash and returns a boolean status for the operation.
## shell.beep() ### `shell.beep()`
Play the beep sound. Play the beep sound.