From 4da7578daba66c82c945ecaeb5f485d6fe8fd156 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 5 Jun 2015 19:05:55 +0800 Subject: [PATCH] :memo: Add getUploadedReports API doc. --- docs/api/crash-reporter.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index d867f77ce398..2064f20f3951 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -27,6 +27,9 @@ crashReporter.start({ * Only string properties are send correctly. * 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 with the `breakpad` on Windows and Linux. To enable crash collection feature, 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 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 The crash reporter will send the following data to the `submitUrl` as `POST`: