add new method and mark setExtraParameter for deprecation

This commit is contained in:
Shelley Vohr 2017-11-01 21:57:43 -04:00
parent 33092e6324
commit 3af83f1c97
No known key found for this signature in database
GPG key ID: F13993A75599653C
8 changed files with 72 additions and 25 deletions

View file

@ -116,16 +116,23 @@ called before `start` is called.
**Note:** This API can only be called from the main process.
### `crashReporter.setExtraParameter(key, value)` _macOS_
### `crashReporter.addExtraParameter(key, value)` _macOS_
* `key` String - Parameter key, must be less than 64 characters long.
* `value` String - Parameter value, must be less than 64 characters long.
Set an extra parameter to be sent with the crash report. The values
specified here will be sent in addition to any values set via the `extra` option
when `start` was called. This API is only available on macOS, if you need to
add/update extra parameters on Linux and Windows after your first call to
`start` you can call `start` again with the updated `extra` options.
specified here will be sent in addition to any values set via the `extra` option when `start` was called. This API is only available on macOS, if you need to add/update extra parameters on Linux and Windows after your first call to `start` you can call `start` again with the updated `extra` options.
**Note:** This API will be deprecated in `2.0`
### `crashReporter.addExtraParameter(key, value)` _macOS_
* `key` String - Parameter key, must be less than 64 characters long.
* `value` String - Parameter value, must be less than 64 characters long.
Set an extra parameter to be sent with the crash report. The values
specified here will be sent in addition to any values set via the `extra` option when `start` was called. This API is only available on macOS, if you need to add/update extra parameters on Linux and Windows after your first call to `start` you can call `start` again with the updated `extra` options.
### `crashReporter.removeExtraParameter(key)` _macOS_