Commit graph

445 commits

Author SHA1 Message Date
Zeke Sikelianos
ee190ca62a create a one-liner description for each API 2016-04-22 10:32:28 -07:00
Plusb Preco
7fa4b7c8b5 📝 Normalize code tags
[ci skip]
2016-04-22 23:15:31 +09:00
Plusb Preco
4f4277e25e 📝 Fix coding style issues
* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
2016-04-22 22:54:43 +09:00
deepak1556
794d120754 rename importClientCertificate => importCertificate 2016-04-20 08:45:49 +05:30
Kevin Sawicki
389b2b5cdd Merge pull request #4963 from preco21/document-fixes-2
Docs: Improve docs styles
2016-03-31 15:44:31 -07:00
Cheng Zhao
e23faceba0 docs: Add notes on app.getLocale 2016-03-31 17:22:09 +09:00
Plusb Preco
346ef9df0c 📝 Update docs styles
* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
2016-03-31 14:16:14 +09:00
Cheng Zhao
c220753c60 Merge pull request #4896 from felixrieseberg/default-protocol-handler
Enable Electron to set/unset itself as default protocol handler (OS X, Windows)
2016-03-31 10:38:57 +09:00
Felix Rieseberg
1231360b2f Add API: RemoveAsDefaultProtocolHandler 2016-03-28 15:31:01 -07:00
Felix Rieseberg
d2567b0381 Add API: SetASDefaultProtocolHandler
This PR adds an API enabling Electron to set itself as the default
protocol handler for a custom porotocl on both oS X and Windows.

For details, please see `docs/app.md`.

Closes #4857
2016-03-23 22:12:17 -07:00
Takashi Kokubun
8cf4574198 Document app.setName()
[ci skip]
2016-03-22 11:01:23 +09:00
Plusb Preco
ebf509bbe4 📝 Adjust 80 chars per line
[ci skip]
2016-03-10 16:54:07 +09:00
Daniel Pham
0b8c2545b9 📝 Document 'app.focus()'
[ci skip]
2016-03-09 09:03:38 -05:00
Daniel Pham
68b453770b 🍎 Rename 'isDarkModeEnabled' to 'isDarkMode' 2016-03-06 10:55:47 -05:00
Daniel Pham
63294892f0 Rename dark-mode-changed to platform-theme-changed 2016-03-03 23:58:58 -05:00
Daniel Pham
c4049cb393 🍎 Add 'dark-mode-changed' event to app api 2016-03-01 15:43:38 -05:00
Daniel Pham
eaac67ac60 🍎 Add 'isDarkModeEnabled' to app api 2016-03-01 13:12:21 -05:00
Brad Metcalf
2a6fcf48e5 Changed session to app to reflect rest of document 2016-02-18 13:41:22 -06:00
Jacob Page
9c9759a683 Link to Menu documentation
Added link to documentation about `Menu` objects
2016-02-17 21:30:01 -08:00
Cheng Zhao
e47a815c38 Merge pull request #4482 from lukeapage/patch-7
spelling fixes and americanisms
2016-02-16 20:22:31 +08:00
Luke Page
a141d6b3d4 spelling fixes and americanisms 2016-02-15 06:51:20 +01:00
Jacob Page
17603d5dfb makeSingleInstance clarification
Removed callback return value from the sample code for makeSingleInstance because it appears to not be used for anything.
2016-02-14 19:13:11 -08:00
Adam Lynch
5911c45b54 Docs: app: small process.argv clarification 2016-02-07 17:31:37 +00:00
Simon Madine
f9efdc4435 🍎 Add Show to API for OS X 2016-01-30 22:30:38 +01:00
Simon Madine
7a370ccd0f 🍎 Add 'Hide' to App API for OS X only 2016-01-29 16:09:54 +01:00
ragingwind
7229d2462a Add app.dock.setIcon to change icon of dock 2016-01-24 08:30:14 +09:00
Eran Tiktin
f42d283fcd Add documentation 2016-01-16 07:18:20 +02:00
Jason Zhekov
2f732a7c0f Formatting app.md
This looks a bit odd on the site: http://electron.atom.io/docs/v0.36.0/api/app/#app-setusertasks-tasks-windows
2015-12-22 09:04:36 +02:00
Kevin Sawicki
e1654ee334 📝 Document quit event includes exit code 2015-12-09 18:22:54 -08:00
Cheng Zhao
a551b8eaaa Merge pull request #3590 from vQuagliaro/doc-windows-open-file
[doc] open-file and open-url events are only available on OS X
2015-11-26 18:34:12 +08:00
Vincent Quagliaro
fe4638ef33 📝 open-file and open-url events are only available on OS X 2015-11-26 09:09:45 +01:00
Cheng Zhao
08c13cf446 Deprecate app.resolveProxy
There is now a public API to get default session, this helper is no
longer necessary.
2015-11-19 21:32:46 +08:00
Cheng Zhao
9ca022c98a docs: Update the certificate APIs 2015-11-18 11:35:26 +08:00
Cheng Zhao
341341bf28 Rename select-certificate to select-client-certificate 2015-11-18 10:10:21 +08:00
Cheng Zhao
24f573eceb Merge pull request #3344 from deepak1556/certificate_verifier_api_patch
session: api to allow handling certificate verification
2015-11-17 18:53:35 +08:00
Cheng Zhao
d3caea91b0 Add paths from chrome_paths 2015-11-13 13:05:16 +08:00
Cheng Zhao
996a3c2a35 Merge branch 'content_tracing_patch' of https://github.com/deepak1556/atom-shell into deepak1556-content_tracing_patch 2015-11-13 12:29:18 +08:00
Robo
bfaa50a79e retrieve download directory using on linux 2015-11-13 07:44:05 +05:30
Robo
d072e61282 session: api to allow handling certificate verification 2015-11-13 01:27:30 +05:30
Cheng Zhao
eac2e7cc61 docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00
Cheng Zhao
863199348f Make process.exit() quit gracefully
Instead of abrupting the whole program immediately, we should close all
windows and release all native resources gracefully on exit. This avoids
possible crashes.

Fix #3350.
2015-11-06 20:25:20 +08:00
Cheng Zhao
726910df39 docs: app.setAppUserModelId 2015-11-03 15:36:44 +08:00
Plusb Preco
b8cc2e1649 Remove extra spaces 2015-10-29 14:22:00 +09:00
Cheng Zhao
862c3187f5 docs: login event 2015-10-28 21:14:00 +08:00
Cheng Zhao
61f07307cb docs: New behaviors of makeSingleInstance 2015-10-22 19:26:05 +08:00
Cheng Zhao
70e74d05e0 Revert "app.makeSingleInstance is not available on OS X"
This reverts commit bcb78ebc00.
2015-10-22 17:03:18 +08:00
Cheng Zhao
bcb78ebc00 app.makeSingleInstance is not available on OS X 2015-10-22 15:02:32 +08:00
Cheng Zhao
63cc2ec369 docs: Make code more JS-style 2015-10-22 14:24:09 +08:00
Paul Betts
759b6a1534 📝 for makeSingleInstance 2015-10-21 13:52:17 -07:00
Paul Betts
285a4789b3 Update app.md 2015-10-20 12:35:56 -07:00
Ionică Bizău
1ad979f9bd Add some missing words ("be" and "the") 2015-10-20 19:44:01 +03:00
Cheng Zhao
c928894627 docs: app.allowNTLMCredentialsForAllDomains 2015-10-20 13:56:31 +08:00
Cheng Zhao
3d4318e15e docs: Remove cache and userCache dir
Closes #1404.
2015-10-04 21:20:05 +08:00
Ryohei Ikegami
7b75b29265 Add docs for app.getLocale() 2015-09-16 17:17:49 +09:00
Haojian Wu
40d93ce55a Deprecate 'activate-with-no-open-windows' event. 2015-09-14 18:36:05 -07:00
Haojian Wu
377e7ee3a7 Implement 'activiate' event instead of 'activate-with-open-windows'. 2015-09-14 18:34:27 -07:00
Haojian Wu
c006c4efa4 Mention 'activate-with-no-open-windows' on OS X only. 2015-09-14 20:34:45 +08:00
Haojian Wu
3ad5d17612 [OS X] Implement 'activate-with-open-windows' event for app. 2015-09-14 20:32:50 +08:00
Cheng Zhao
8534ff4526 docs: browser-window-created event 2015-09-14 17:02:36 +08:00
Jessica Lord
279fd0a461 Standardize **Note:** 2015-09-09 14:09:14 -07:00
Robo
af52eda0eb process: api to set file descriptor soft limit 2015-08-31 13:00:04 +05:30
Jessica Lord
aeb37941bb Replace platform notes with one general note 2015-08-25 10:12:21 -07:00
Jessica Lord
7f72207e66 Add platform label where applicable 2015-08-24 15:33:07 -07:00
Jessica Lord
d87c8a8291 Add optional notation 2015-08-24 14:56:19 +02:00
Jessica Lord
9b84dc4e1a Line wrap 80 2015-08-24 14:38:29 +02:00
Jessica Lord
714745cdd7 Add 'returns' and change h2 descriptions 2015-08-19 18:51:36 +02:00
Jessica Lord
624b6b9762 Standardize app.md 2015-08-19 18:28:48 +02:00
Alex Ryan
fb60f7946f Fixed typo 2015-08-06 22:15:59 -07:00
Jeffrey Morgan
5010c15ffc Improve grammar and sentence structure of app.md
Improve the grammar and sentence structure of app.md. Replace references to Mac with OS X for consistency with other docs and use the OS X nomenclature of notification rather than message.
2015-07-18 15:40:01 +01:00
Haojian Wu
a2857d2dca Implment app.getAppPath API. 2015-07-07 17:37:53 +08:00
Cheng Zhao
a3ec50437d Rename event name to gpu-process-crashed 2015-06-26 10:34:38 +08:00
Cheng Zhao
5b5393e82b docs: gpu-crashed is moved to app 2015-06-26 10:34:13 +08:00
deepak1556
0fbd908fb6 app: event to pass client certificate data 2015-06-25 21:29:21 +05:30
deepak1556
2f36f5ca78 app: adding browser-window-focus/blur events 2015-06-18 11:29:08 +05:30
Cheng Zhao
e96119fc32 s/liste/listen 2015-06-16 10:08:32 +08:00
Benjamin Pasero
7da3e84369 Update app.md to document how open-file is emitted
On Mac, open-file is also emitted when the application is not yet running.
2015-06-12 12:37:53 +02:00
Cheng Zhao
f02cae1b0a docs: app.terminate is deprecated 2015-05-11 10:22:19 +08:00
Cheng Zhao
d2682233fd docs: Atom Shell => Electron 2015-04-16 11:31:12 +08:00
liang feng
5460b84c60 modify param description 2015-03-30 16:13:11 +08:00
Charlie Hess
b6787a9b34 Emit a new before-quit event at the start of Browser::Quit, which gives us a chance to cancel before any windows are closed. 2015-02-25 19:33:42 -08:00
Cheng Zhao
4604c9bb0e Add a few more paths for app.getPath 2015-01-18 21:43:23 -08:00
Cheng Zhao
8aa5b97c61 docs: Say more about Linux's behavior 2015-01-18 21:43:22 -08:00
Cheng Zhao
ce52a87477 Add "cache" and "userCache" directories 2015-01-18 21:43:22 -08:00
Cheng Zhao
9a04f67c0a docs: Mention when to override userData path 2015-01-18 21:43:21 -08:00
Cheng Zhao
dec3e37683 docs: Document app.getPath/app.setPath 2015-01-18 21:43:20 -08:00
Cheng Zhao
afde383e28 docs: app.setUserTasks 2014-11-17 19:50:34 +08:00
Cheng Zhao
bf66aeb8ee docs: Recent documents API 2014-11-17 19:02:37 +08:00
Cheng Zhao
f706bb45cb docs: app.dock.setMenu 2014-11-17 18:48:02 +08:00
Cheng Zhao
909ff085ac Add "quit" event for app. 2014-09-25 21:48:15 +08:00
Cheng Zhao
cfae3cd3af Add app.resolveProxy API, fixes #545. 2014-08-19 21:26:45 +08:00
Cheng Zhao
78afa29ade Little formating on app.getDataPath. 2014-08-17 11:33:55 +08:00
Corné Dorrestijn
3afb4e017c Added the getDataPath function to the app api docs 2014-08-15 17:29:36 +02:00
Cheng Zhao
8ecc4061a8 mac: Add app.dock.hide()/show() APIs, closes #422. 2014-06-25 11:55:33 +08:00
Pascal Borreli
831c7f5924 Fixed typos 2014-05-07 07:34:53 +01:00
Cheng Zhao
5933947000 📝 Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00
Renamed from docs/api/browser/app.md (Browse further)