Zeke Sikelianos
56ee50f3a3
use lowercase for optional annotation
2017-06-13 13:50:10 -07:00
Samuel Attard
de066b8d13
Make clearStorageData options object's property optional
...
Fixes #9749
2017-06-14 04:34:13 +10:00
Kevin Sawicki
3ec7900e6e
Merge pull request #9154 from miniak/fix-api-docs
...
Fix api docs
2017-04-10 08:16:54 -07:00
Milan Burda
8f46137fda
Fix session.setPermissionRequestHandler webContents argument type
2017-04-10 02:12:15 +02:00
Kevin Sawicki
b7b7f28c5a
Link properties to class docs
2017-04-08 18:50:55 -07:00
Samuel Attard
f97066511f
Capitalize type
2017-03-07 21:25:40 +11:00
João Moreno
5a4d9807ee
Update ses.resolveProxy return type
...
As far as I'm aware, after using the `ses.resolveProxy` API, it seems to return a string in the shape of `PROXY foopy:80;SOCKS5 bar.com:1080`, not an object. Correct me if I'm wrong.
2017-03-07 11:21:51 +01:00
Kevin Sawicki
91bd95a0b2
Add space after if
2017-02-22 08:11:21 -08:00
René Herrmann
c4280612c1
update setCertificateVerifyProc example
...
setCertificateVerifyProc example should reflect new api
2017-02-22 11:49:14 +01:00
Fabian Zeindl
46c65ae5fc
Update session.md
2017-02-12 10:06:24 +01:00
Kevin Sawicki
70178adb6e
Use object for verification request
2017-02-08 11:59:43 -08:00
Greg Nolle
e29b64a18a
modify CertVerifier Class
...
* respond to multiple similar verification requests.
* accept net error result as callback response.
2017-02-08 11:59:43 -08:00
Chandan Rai
4a6cbd76c8
corrected typo
2017-02-03 19:26:37 +05:30
Drew Chandler
b28a865436
Use localstorage in clearStorageData docs
...
It won't work if you use include the space that is currently in the docs.
2016-12-22 09:51:39 -08:00
Zeke Sikelianos
e57cb713b2
link process annotations to glossary
2016-12-21 13:47:40 -08:00
Kevin Sawicki
f99dabbac6
Merge pull request #8078 from electron/dts-docs-update-again
...
Update Docs
2016-12-21 13:39:53 -08:00
deepak1556
975d677f55
add docs
2016-12-09 09:56:16 -08:00
deepak1556
d944219b28
add docs
2016-12-09 09:37:46 -08:00
Samuel Attard
06960704c4
Update docs for dts again
2016-11-25 23:17:31 +11:00
Zeke Sikelianos
b084dc29ea
move each API doc into its own file
2016-11-16 09:02:49 -08:00
Zeke Sikelianos
21105271a4
document processes for APIs nested in parent docs
2016-11-03 11:50:00 -07:00
Zeke Sikelianos
ac68de6215
document process(es) for all APIs
2016-11-03 10:26:00 -07:00
Kevin Sawicki
a2a44621fd
Merge pull request #7708 from tinydew4/fix-typo
...
Fix typo, and trimming.
2016-10-24 16:12:29 +09:00
tinydew4
67a09d9fe0
Fix typo, and trimming.
2016-10-24 06:34:09 +00:00
Kevin Sawicki
632739ec6e
Merge pull request #7590 from electron/docs-cleanup
...
Cleanup docs and standardize structs
2016-10-24 15:13:39 +09:00
Samuel Attard
20323e7032
Specifiy function param types in docs
2016-10-13 17:30:57 +11:00
Samuel Attard
78343a62b8
Cleanup docs and standardize structs
2016-10-13 14:38:06 +11:00
Kevin Sawicki
96e48ac13c
Document cookie changed event
2016-09-29 09:16:35 -07:00
Samuel Attard
e0e47ea9a1
Update docs to contain more specific return values
2016-09-28 18:28:44 +13:00
Samuel Attard
d2a701a465
Document the return values of all methods in the docs
2016-09-25 12:59:30 +13:00
deepak1556
7b85ca0301
create helper class to read blob data
2016-09-01 08:52:44 +05:30
deepak1556
be4bc6b7ef
fix docs and update specs
2016-09-01 01:01:52 +05:30
deepak1556
a23e7ecf8f
add docs
2016-09-01 01:01:52 +05:30
Zeke Sikelianos
7ff5649965
fix optional param spacing
2016-08-26 23:47:04 -07:00
Kevin Sawicki
1276587ebe
Merge pull request #6934 from electron/add-missing-class-descriptions
...
Give every class a description
2016-08-23 10:16:29 -07:00
Zeke Sikelianos
098d4dc0ca
improve wording about class instantiation
2016-08-22 21:45:25 -07:00
Kevin Sawicki
4fc6cf48b0
Document enableNetworkEmulation defaults
2016-08-22 14:25:42 -07:00
Zeke Sikelianos
3d371e09b7
add a blockquote for every class
2016-08-22 14:11:03 -07:00
Kevin Sawicki
e84d0ebb7e
Merge pull request #6932 from electron/fix-power-save-blocker-doc-bug
...
Fix some invalid docs
2016-08-22 12:30:00 -07:00
Zeke Sikelianos
8c0a551d25
fix linting errors in docs
2016-08-22 11:47:55 -07:00
Haojian Wu
6a9801b82c
Remove an extra space in front of #.
2016-08-12 22:01:30 +02:00
Zeke Sikelianos
06a354a2eb
standardize all javascript blocks in English docs
2016-07-26 09:48:19 -07:00
deepak1556
aa6d79a3d8
session: add proxyBypassRules option to setProxy api
2016-07-21 10:14:54 +05:30
liusi
154daa8d6a
make Session::ClearStorageData's callback optional
2016-07-15 14:13:56 +08:00
Cheng Zhao
e7666b0448
docs: options of session.fromPartition
2016-07-13 12:23:14 +09:00
Kevin Sawicki
5b8c4f55e7
Update key to be httpOnly instead of session
2016-06-29 08:39:20 -07:00
Cheng Zhao
1a74177e2d
docs: Separate Cookies and WebRequest classes in session.md
2016-06-22 16:34:58 +09:00
Cheng Zhao
6b1df5838c
docs: ses.setUserAgent(userAgent[, acceptLanguages])
2016-06-22 16:05:38 +09:00
Cheng Zhao
62d0dbea5a
docs: Reformat the menu-item.md
2016-06-22 13:23:07 +09:00
deepak1556
4749e18fc0
fix spec and docs
2016-06-09 10:48:05 +05:30
deepak1556
ebff40b5a5
add docs
2016-06-09 10:39:18 +05:30
Cheng Zhao
3ec4fcb3ec
bellow => below
2016-06-08 11:03:01 +09:00
Vadim Macagon
c2633460eb
Improve documentation of ses.cookies.set()
...
Fix description of the `details.url` param in `ses.cookies.set()`, and clarify the fact that cookies without an expiration date will not be retained between sessions.
2016-05-25 12:46:17 +07:00
deepak1556
f68d0f324f
deprecate app.allowNTLMCredentialsForAllDomains
2016-05-23 11:44:21 +05:30
Plusb Preco
4cdba29fbd
📝 Match object notation style
...
[ci skip]
2016-05-11 10:30:02 +09:00
Plusb Preco
f1b184ef78
📝 Fix code style issue
...
* Change `var` to `let`.
* Change `function() {}` to `() => {}`.
* Use shorthand function syntax on object notation.
* Remove spaces between object notation brackets.
* Small fixes.
2016-05-11 02:15:09 +09:00
Plusb Preco
4d7296e1db
📝 Match destructuring style
...
[ci skip]
2016-05-11 01:26:38 +09:00
Plusb Preco
5787bb0226
📝 Fix code style issue
...
* Match equality operators for consistent that `==`, `!=` by `===`,
`!==`.
* Match string expression notation `"` by `'`.
[ci skip]
2016-05-10 18:42:21 +09:00
Steve Kinney
5a9f28e034
📝 Update API documentation to ES6 [ci skip]
2016-05-04 11:59:02 -06:00
Zeke Sikelianos
2c8261b429
update excerpts based on feedback
2016-04-22 10:32:28 -07:00
Zeke Sikelianos
0527b17e42
blockquote summaries
2016-04-22 10:32:28 -07:00
Zeke Sikelianos
ee190ca62a
create a one-liner description for each API
2016-04-22 10:32:28 -07:00
Plusb Preco
6205dfa25f
📝 Remove additional whitespaces
...
[ci skip]
2016-04-22 23:30:41 +09:00
Plusb Preco
a14014941b
📝 Fix coding style issues
...
[ci skip]
2016-04-22 23:26:19 +09:00
Plusb Preco
66f4701d93
📝 Remove additional whitespaces
...
[ci skip]
2016-04-22 23:23:15 +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
ca756c3c24
session: allow providing permission to handle external protocols
2016-04-21 05:27:07 +05:30
deepak1556
3fb39ad3ef
provide option to override status line
2016-04-08 14:03:57 +05:30
Cheng Zhao
bb1e4c2208
Revert "add docs"
...
This reverts commit bdfc19ad20
2016-02-24 13:25:22 +08:00
Robo
bdfc19ad20
add docs
2016-02-23 12:54:20 +05:30
Cheng Zhao
f624800881
Merge pull request #4314 from deepak1556/download_cancel_patch
...
fix crash when default download is canceled
2016-02-02 18:40:44 +08:00
Robo
2819af9586
fix lifetime of downloadItem class when defaultdownload canceled
2016-02-02 15:54:51 +05:30
Robo
ce2ea963b9
session: api to clear host resolver cache
2016-02-02 02:06:49 +05:30
Cheng Zhao
69f93a7528
Merge pull request #4223 from deepak1556/notification_disable_patch
...
session: add setPermissionRequestHandler api
2016-02-01 20:51:22 +08:00
Robo
b575cd0ef9
add fullscreen permission type
2016-02-01 16:22:05 +05:30
Robo
db26dcaf4c
expose handler from session and remove permission-request event
2016-02-01 12:23:51 +05:30
Petr Felzmann
0169f31feb
fix bullets formatting in documentation
2016-01-29 20:10:18 +01:00
Cheng Zhao
f820b0db83
docs: Revise the webRequest and protocol docs
2016-01-28 18:59:07 +08:00
Robo
dc0151099c
session: provide uploadData with webrequest api when available
2016-01-27 18:39:40 +05:30
Robo
10e4698baa
session: api to get current cache size
2016-01-14 17:15:45 +05:30
Robo
8433d94cac
session: api to flush DOMStorage data
2016-01-13 08:56:00 +05:30
Cheng Zhao
192fa4c86b
Cleanup docs and code of setProxy
2016-01-11 22:45:34 +08:00
Robo
8557cd223c
maintain api compatibility
2016-01-11 12:24:01 +05:30
Robo
be50ca2653
session: allow user to isolate pac script and proxy bypass rules
2016-01-11 03:55:56 +05:30
Cheng Zhao
d5168f09d6
docs: Use "(optional)" instead of "__optional__"
2015-12-18 11:12:48 +08:00
Cheng Zhao
56c1f04a51
docs: Update webRequest API
2015-12-12 15:45:02 +08:00
Cheng Zhao
ab14a4466d
docs: Improve the cookies docs
2015-12-12 15:41:04 +08:00
Cheng Zhao
d3e723557e
spec: Add test cases for webRequest
2015-12-12 11:31:19 +08:00
Cheng Zhao
b7fce578d5
docs: Improve the webRequets docs
2015-12-11 19:02:56 +08:00
Robo
658accab94
fix pointer usage
2015-12-11 00:25:25 +05:30
Robo
461ee49988
fix response headers modification
2015-12-09 20:14:18 +05:30
Robo
c5b5bbbeb2
add documentation
2015-12-09 20:14:18 +05:30
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
44c562ebd9
docs: New session methods
2015-11-19 21:31:39 +08:00
Cheng Zhao
9ca022c98a
docs: Update the certificate APIs
2015-11-18 11:35:26 +08:00
Cheng Zhao
961ee5a4d9
Rename verify-certificate to untrusted-certificate
2015-11-17 21:41:36 +08:00
Cheng Zhao
ebe66daa56
Emit verify-certificate only when default verifier fails
2015-11-17 21:36:36 +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
fbb8e61958
Replace "Url" in API names with "URL"
2015-11-13 16:03:40 +08:00
Robo
37e6e6fab7
emit verify-certificate event for handling verification
2015-11-13 06:44:49 +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
Robo
e9a5d05b27
session: allow setproxy to use external pac script
2015-10-22 23:03:47 +05:30
Robo
db0732b35b
add examples
2015-09-28 12:52:50 +05:30
Robo
fc7f4ae24b
session: api to emulate network conditions
2015-09-27 18:55:26 +05:30
Haojian Wu
01f0643142
Fix inconsistent docs: downloadItem.getURL() => downloadItem.getUrl()
2015-09-25 09:34:04 +08:00
Haojian Wu
0861d5d44b
Redefine 'will-download' design.
2015-09-24 16:04:44 +08:00
Haojian Wu
dd38131704
📝 Add DownloadItem doc.
2015-09-21 09:34:42 +08:00
Cheng Zhao
0cb20c48f6
docs: Small changes to will-download event
2015-09-01 20:16:28 +08:00
Robo
4062ca5f68
implement wrapSession
2015-09-01 16:50:42 +05:30
Jessica Lord
5f1897713c
Edits, grammar, punctuation and merge conflicts
2015-08-26 13:57:42 -07:00
Jessica Lord
38b519ceb5
Add (optional) notation
2015-08-26 10:45:57 -07:00
Jessica Lord
c282d4c0ff
Line wrap 80-col
2015-08-26 10:45:57 -07:00
Jessica Lord
00de81771c
Text edits per commit comments
2015-08-26 10:45:16 -07:00
Jessica Lord
840095b444
Break out methods, standardize
2015-08-26 10:45:15 -07:00
