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

📝 Add getUploadedReports API doc.

Browse source
This commit is contained in:
Haojian Wu 2015-06-05 19:05:55 +08:00
parent c821a06e2f
commit 4da7578dab
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -27,6 +27,9 @@ crashReporter.start({
* Only string properties are send correctly. * Only string properties are send correctly.
* Nested objects are not supported. * Nested objects are not supported.
Developers are required to call the API before using other crashReporter APIs.
**Note:** On OS X, electron uses a new `crashpad` client, which is different **Note:** On OS X, electron uses a new `crashpad` client, which is different
with the `breakpad` on Windows and Linux. To enable crash collection feature, with the `breakpad` on Windows and Linux. To enable crash collection feature,
you are required to call `crashReporter.start` API to initiliaze `crashpad` in you are required to call `crashReporter.start` API to initiliaze `crashpad` in
@ -37,6 +40,10 @@ main process, even you only collect crash report in renderer process.
Returns the date and ID of last crash report, when there was no crash report Returns the date and ID of last crash report, when there was no crash report
sent or the crash reporter is not started, `null` will be returned. sent or the crash reporter is not started, `null` will be returned.
## crashReporter.getUploadedReports()
Returns all uploaded crash reports, each report contains date and uploaded ID.
# crash-reporter payload # crash-reporter payload
The crash reporter will send the following data to the `submitUrl` as `POST`: The crash reporter will send the following data to the `submitUrl` as `POST`: