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

shouldUpload --> uploadToServer

Browse source
This commit is contained in:
Samuel Attard 2016-11-22 19:30:20 +11:00 • committed by Kevin Sawicki
parent a7dedb3a13
commit 2bf6f28152
11 changed files with 41 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/api/crash-reporter.md
View file

@ -40,7 +40,7 @@ The `crashReporter` module has the following methods:
* `companyName` String (optional)
* `submitURL` String - URL that crash reports will be sent to as POST.
* `productName` String (optional) - Defaults to `app.getName()`.
* `shouldUpload` Boolean (optional) _macOS_ - Whether crash reports should be sent to the server
* `uploadToServer` Boolean (optional) _macOS_ - Whether crash reports should be sent to the server
Default is `true`.
* `ignoreSystemCrashHandler` Boolean (optional) - Default is `false`.
* `extra` Object (optional) - An object you can define that will be sent along with the
@ -70,16 +70,16 @@ Returns [`CrashReport[]`](structures/crash-report.md):
Returns all uploaded crash reports. Each report contains the date and uploaded
ID.
### `crashReporter.getShouldUpload()` _macOS_
### `crashReporter.getUploadToServer()` _macOS_
Returns `Boolean` - Whether reports should be submitted to the server. Set through
the `start` method or `setShouldUpload`.
the `start` method or `setUploadToServer`.
**NOTE:** This API can only be used from the main process
### `crashReporter.setShouldUpload(shouldUpload)` _macOS_
### `crashReporter.setUploadToServer(uploadToServer)` _macOS_
* `shouldUpload` Boolean _macOS_ - Whether reports should be submitted to the server
* `uploadToServer` Boolean _macOS_ - Whether reports should be submitted to the server
This would normally be controlled by user preferences.