By default, Instabug is shown when the device is shaken. This can be changed to several other events that can show the SDK. You can also show the SDK manually from a custom gesture or a button you add to your app.
You can set the SDK to be invoked when your users do one or more of the following actions:
- Shake device
- Take a screenshot
- Tap on a floating button shown above your app's UI
- Pan to the left from the right edge of the screen (one-finger swipe left)
- Swipe with two fingers from right to left
- None (manual showing)
Screenshot Gesture Recommendation
We recommend using the screenshot gesture to show Instabug only in your internal and beta builds. The screenshot gesture is already utilized by the OS to show the edit view of the captured screenshot. Hence, while using Instabug in your live app on the App Store, we recommend using the other gestures: shake, pan, two fingers swipe or manually through the app's UI.
You have the option to set one or multiple invocation events. To customize the invocation events, pass the values of the
IBGInvocationEvent enum when starting the SDK.
Instabug.start(withToken: "YOUR-TOKEN-HERE", invocationEvents: [.shake, .screenshot])
[Instabug startWithToken:@"YOUR-TOKEN-HERE" invocationEvents: IBGInvocationEventShake | IBGInvocationEventScreenshot];
The possible invocation events are below.
.none .shake .screenshot .twoFingersSwipeLeft .rightEdgePan .floatingButton
IBGInvocationEventNone IBGInvocationEventShake IBGInvocationEventScreenshot IBGInvocationEventTwoFingersSwipeLeft IBGInvocationEventRightEdgePan IBGInvocationEventFloatingButton
Use the "none" event if you want to show the SDK manually in order to prevent the SDK from being shown through the other events.
If you set the event to "none" and you're showing Instabug manually from your app's UI, we recommend that you set up custom categories. Typically, while using the other gestures, the user can invoke Instabug from any screen in the app once they spot an issue which allows the SDK to capture the current screen and attach it to the report. However, when you limit invoking Instabug to a specific screen (help or settings for example), the current screen that the SDK captures won't necessarily be relevant to the issue. The recommended alternative is that you set up a list of custom categories that match the main features or views in your app and let the user choose one of them.
If you are using the floating button, you can set its default position as explained here.
If you are using the shaking gesture as your invocation event, you can set how sensitive the device should be to the shaking. The thresholds in the example below are the default values. The higher the value, the less sensitive the device will be to shaking.
BugReporting.shakingThresholdForiPhone = 3.0 BugReporting.shakingThresholdForiPad = 1.0
IBGBugReporting.shakingThresholdForiPhone = 3.0; IBGBugReporting.shakingThresholdForiPad = 1.0;
If you want to change the invocation event to any of the other supported events, you can do so at runtime as shown below.
BugReporting.invocationEvents = [.shake, .screenshot]
[IBGBugReporting setInvocationEvents:IBGInvocationEventShake | IBGInvocationEventScreenshot];
If you want to show the SDK manually, use the
When you limit invoking Instabug to a specific screen (help or settings for example), the current screen that the SDK captures won't necessarily be relevant to the issue. To help you gain more context, it is recommended that you set up a list of custom categories that match the main features or views in your app and let the user choose one of them. You can find more details here.
By default, when the Instabug SDK is shown, a popup appears to your app users with options for them to report a bug ("Report a bug"), share feedback ("Suggest an improvement"), or ask you a question ("Ask a question").
Instead of showing this Prompt Options menu that lets your users choose what they want to do, you can skip this step and take users directly to the bug, feedback, or question reporting flow.
For bug, feedback, and questions, you can also specify invocation options as described here.
This API will show users a form they can use to submit new bug reports.
BugReporting.show(with: .bug, options: )
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeBug options:0];
This API will show users a form they can use to submit new feedback and suggestions.
BugReporting.show(with: .feedback, options: )
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeFeedback options:0];
This API will show users a form they can use to submit a new question.
BugReporting.show(with: .question, options: )
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeQuestion options:0];
This API will show users a page where they can see all their ongoing chats. If the user has no ongoing chats, this API won't have an effect.
Sometimes, you might need to disable or enable Instabug if, for example, the user would like to opt out of collecting any sort of logs, bugs, crashes, or survey responses. This can be done using the API below:
//Enable Instabug.enabled= true; //Disable Instabug.enabled= false;
If Instabug is disabled, all user data and attributes are deleted from the device. Answered surveys will be stored in case Instabug is enabled again in order to not show the survey once more. Storing user attributes will not be available while Instabug is disabled.
Updated 3 months ago