Rename autoUpload to shouldUpload

This commit is contained in:
Samuel Attard 2016-11-08 11:03:57 +11:00 committed by Kevin Sawicki
parent 774b2f99f2
commit 7b8eb3e09c
11 changed files with 51 additions and 18 deletions

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()`.
* `autoSubmit` Boolean (optional) - Send the crash report without user interaction.
* `shouldUpload` 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,6 +70,12 @@ Returns [`CrashReport[]`](structures/crash-report.md):
Returns all uploaded crash reports. Each report contains the date and uploaded
ID.
### `crashReporter.setShouldUpload(shouldUpload)`
* `shouldUpload` Boolean _macOS_ - Whether reports should be submitted to the server
This would normally be controlled by user preferences.
## Crash Report Payload
The crash reporter will send the following data to the `submitURL` as