HomeDocumentationAPI Reference
Getting StartedAPI ReferenceHelp CenterVideo Tours

Show Specific Mode

You can show Instabug with a specific mode and option directly using these APIs. If you're showing a bug reporting mode specifically, the API has two fields, Report Type and Option.

All the possible invocation modes are listed to the right. These modes can be used to show a specific view right away. The possible modes are:

  • Show New Bug Page
  • Show New Feedback Page
  • Show New Chat Page
  • Show Chats List Page

Here are all the possible invocation options used to customize the new bug or feedback experience.

  • 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

You can pass any number of invocation options in a single method call. If no invocation option is passed, the email field will automatically be shown and set to required and the comment field will be set to optional.

Method

// Compose a new bug report
BugReporting.show(with: .bug, options: [])
// Compose a new feedback
BugReporting.show(with: .feedback, options: [])
// Compose a new question
BugReporting.show(with: .question, options: [])
// Show the perevious chats list
Replies.show()
// Compose a new bug report
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeBug options:0];
// Compose a new feedback
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeFeedback options:0];
// Compose a new question
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeQuestion options:0];
// Show the perevious chats list only of the the user already have a chats history. Calling this API won't have an effect otherwise.
[IBGReplies show];
// Compose a new bug report
BugReporting.show(BugReporting.ReportType.BUG)
// Compose a new feedback
BugReporting.show(BugReporting.ReportType.FEEDBACK)
// Compose a new question
BugReporting.show(BugReporting.ReportType.QUESTION)
// Show the perevious chats list
Replies.show();
// Compose a new bug report
BugReporting.showWithOptions(BugReporting.reportType.bug, [BugReporting.option.emailFieldHidden]);
// Compose a new feedback
BugReporting.showWithOptions(BugReporting.reportType.feedback, [BugReporting.option.emailFieldOptional]);
// Compose a new question
BugReporting.showWithOptions(BugReporting.reportType.question, [BugReporting.option.emailFieldOptional]);
// Show the previous chats list
Replies.show();
// Compose a new bug report
cordova.plugins.bugReporting.showWithOptions(cordova.plugins.bugReporting.reportType.bug, [cordova.plugins.bugReporting.invocationOptions.emailFieldHidden], successCb, errorCb)
// Compose a new feedback
cordova.plugins.bugReporting.showWithOptions(cordova.plugins.bugReporting.reportType.feedback, [cordova.plugins.bugReporting.invocationOptions.emailFieldHidden], successCb, errorCb)
// Compose a new question
cordova.plugins.bugReporting.showWithOptions(cordova.plugins.bugReporting.reportType.question, [cordova.plugins.bugReporting.invocationOptions.emailFieldHidden], successCb, errorCb)
// Show the previous chats list
cordova.plugins.replies.show(successCb, errorCb)
// Compose a new bug report
IBGBugReporting.ShowWithReportType(IBGBugReportingReportType.Bug, IBGBugReportingOption.EmailFieldHidden);
// Compose a new feedback
IBGBugReporting.ShowWithReportType(IBGBugReportingReportType.Feedback, IBGBugReportingOption.EmailFieldHidden);
// Compose a new question
IBGBugReporting.ShowWithReportType(IBGBugReportingReportType.Question, IBGBugReportingOption.EmailFieldHidden);
// Show the previous chats list
IBGReplies.Show();
// Compose a new bug report
BugReporting.showWithOptions(BugReporting.reportType.bug, [BugReporting.option.emailFieldHidden]);
// Compose new feedback
BugReporting.showWithOptions(BugReporting.reportType.feedback, [BugReporting.option.emailFieldOptional]);
// Compose a new question
BugReporting.showWithOptions(BugReporting.reportType.question, [BugReporting.option.emailFieldOptional]);
// Show the previous chats list
Replies.show();
Report Type Parameters:

//Show New Bug
.bug
//Show New Feedback
.feedback
//Show New Question
.question
//Show New Bug
IBGBugReportingReportTypeBug
//Show New Feedback
IBGBugReportingReportTypeFeedback
//Show New Question
IBGBugReportingReportTypeQuestion
//Show New Bug
BugReporting.ReportType.BUG
//Show New Feedback
BugReporting.ReportType.FEEDBACK
//Show New Question
BugReporting.ReportType.QUESTION
//Show New Bug
BugReporting.reportType.bug
//Show New Feedback
BugReporting.reportType.feedback
//Show New Question
BugReporting.reportType.question
//Show New Bug
cordova.plugins.bugReporting.reportType.bug
//Show New Feedback
cordova.plugins.bugReporting.reportType.feedback
//Show New Question
cordova.plugins.bugReporting.reportType.question
//Show New Bug
IBGBugReportingReportType.Bug
//Show New Feedback
IBGBugReportingReportType.Feedback
//Show New Question
IBGBugReportingReportType.Question
//Show New Bug
BugReporting.reportType.bug
//Show New Feedback
BugReporting.reportType.feedback
//Show New Question
BugReporting.reportType.question
Option Parameters:

//Hide email
.emailFieldHidden
//Show email as optional
.emailFieldOptional
//Make comment required
.commentFieldRequired
//Disable post sending dialog
.disablePostSendingDialog
//Hide email
IBGBugReportingInvocationOptionEmailFieldHidden
//Show email as optional
IBGBugReportingInvocationOptionEmailFieldOptional
//Make comment required
IBGBugReportingInvocationOptionCommentFieldRequired
//Disable post sending dialog
IBGBugReportingInvocationOptionDisablePostSendingDialog
//Hide email
EMAIL_FIELD_HIDDEN
//Show email as optional
EMAIL_FIELD_OPTIONAL
//Make comment required
COMMENT_FIELD_REQUIRED
//No post sending dialog
DISABLE_POST_SENDING_DIALOG
//Hide email
BugReporting.option.emailFieldHidden;
//Show email as optional
BugReporting.option.emailFieldOptional;
//Make comment required
BugReporting.option.commentFieldRequired;
//No post sending dialog
BugReporting.option.disablePostSendingDialog;
//Hide email
cordova.plugins.bugReporting.invocationOptions.emailFieldHidden
//Show email as optional
cordova.plugins.bugReporting.invocationOptions.emailFieldOptional
//Make comment required
cordova.plugins.bugReporting.invocationOptions.commentFieldRequired
//No post sending dialog
cordova.plugins.bugReporting.invocationOptions.disablePostSendingDialog
//Hide email
IBGBugReportingOption.EmailFieldHidden
//Show email as optional
IBGBugReportingOption.EmailFieldOptional
//Make comment required
IBGBugReportingOption.CommentFieldRequired