HomeDocumentationAPI Reference
Getting StartedAPI ReferenceBug ReportingCrash ReportingAPMHelp Center
These docs are for v8.1. Click to read the latest docs for v12.0.0.

Email and Comment Requirement (Options)

This API is to manipulate email and comment fields requirement. By default, users will be required to enter their email but the comment section will be optional. This method can take any number of arguments with the arguments being Options.

The comments section can be required for a user to send a bug and the email field can also be hidden or set to optional. Below are all the options:

  • Hide email field on new bug/feedback page
  • Show email field on new bug/feedback page but only optionally
  • Require user to fill comment field before submitting new feedback or bug
##Method
BugReporting.bugReportingOptions = .emailFieldOptional
IBGBugReporting.bugReportingOptions = IBGBugReportingOptionEmailFieldOptional;
BugReporting.setOptions(Option.EMAIL_FIELD_OPTIONAL);
BugReporting.setInvocationOptions([BugReporting.invocationOptions.emailFieldOptional, BugReporting.invocationOptions.commentFieldRequired]);
cordova.plugins.bugReporting.setOptions(cordova.plugins.bugReporting.invocationOptions.emailFieldOptional, successCb, errorCb)
IBGBugReporting.BugReportingOptions = IBGBugReportingOption.EmailFieldOptional;
Options Parameters:

//Hide email
.emailFieldHidden
//Show email as optional
.emailFieldOptional
//Make comment required
.commentFieldRequired
//Disable post sending dialog
.disablePostSendingDialog
//No option
.none
//Hide email
IBGBugReportingOptionEmailFieldHidden
//Show email as optional
IBGBugReportingOptionEmailFieldOptional
//Make comment required
IBGBugReportingOptionCommentFieldRequired
//Disable post sending dialog
IBGBugReportingOptionDisablePostSendingDialog
//No option
IBGBugReportingOptionNone
//Hide email
Option.EMAIL_FIELD_HIDDEN
//Show email as optional
Option.EMAIL_FIELD_OPTIONAL
//Make comment required
Option.COMMENT_FIELD_REQUIRED
//Hide email
BugReporting.invocationOptions.emailFieldHidden
//Show email as optional
BugReporting.invocationOptions.emailFieldOptional
//Make comment required
BugReporting.invocationOptions.commentFieldRequired
cordova.plugins.bugReporting.invocationOptions.emailFieldHidden
cordova.plugins.bugReporting.invocationOptions.emailFieldOptional
cordova.plugins.bugReporting.invocationOptions.commentFieldRequired
cordova.plugins.bugReporting.invocationOptions.disablePostSendingDialog
//Hide email
IBGBugReportingOption.EmailFieldHidden
//Show email as optional
IBGBugReportingOption.EmailFieldOptional
//Make comment required
IBGBugReportingOption.CommentFieldRequired