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 shown when your users do one or more of the following actions:
- Shake device
- Take a screenshot (using home + lock buttons)
- Tap on a floating button shown above your app's UI
- Swipe with two fingers from right to left
- None (manual showing)
How to show Instabug
To customize the invocation event, pass one of the values of the
Instabug.invocationEvent enum when starting the SDK.
//iOS IBGBugReporting.InvocationEvents = IBGInvocationEvent.FloatingButton | IBGInvocationEvent.Screenshot; //Android new Instabug.Builder(this, "ANDROID_APP_TOKEN") .SetInvocationEvent(InstabugInvocationEvent.FloatingButton, InstabugInvocationEvent.Shake) .Build();
You can find the possible invocation events below. The None event can be used in case you want to prevent the SDK from being shown by the normal way and show it later on manually whenever you need or under certain conditions.
//iOS IBGInvocationEvent.None IBGInvocationEvent.Shake IBGInvocationEvent.Screenshot IBGInvocationEvent.TwoFingersSwipeLeft IBGInvocationEvent.RightEdgePan IBGInvocationEvent.FloatingButton //Android InstabugInvocationEvent.Shake InstabugInvocationEvent.Screenshot InstabugInvocationEvent.FloatingButton InstabugInvocationEvent.ScreenshotGesture InstabugInvocationEvent.TwoFingerSwipeLeft InstabugInvocationEvent.None
In case 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 your device is to the shaking. The values in the following iOS example are the default ones. In the case of Android, the default value depends on the device used. The higher the value the less sensitive the device will be to shaking.
//iOS IBGBugReporting.ShakingThresholdForiPhone = 3.0; IBGBugReporting.ShakingThresholdForiPad = 1.0; //Android BugReporting.SetShakingThreshold(800);
If you want to change the invocation event to any of the other supported events, you can do so at runtime as shown below.
//iOS IBGBugReporting.InvocationEvents = IBGInvocationEvent.FloatingButton; //Android BugReporting.SetInvocationEvents(InstabugInvocationEvent.Shake, InstabugInvocationEvent.FloatingButton);
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").
The Prompt Options menu appears when Instabug is shown in your app.
Instead of showing the 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.
The following are the possible invocation options to be used with any of the following methods (except for showing the replies page).
//Hide email IBGBugReportingOption.EmailFieldHidden //Show email as optional IBGBugReportingOption.EmailFieldOptional //Make comment required IBGBugReportingOption.CommentFieldRequired
//Hide email Option.EmailFieldHidden //Show email as optional Option.EmailFieldOptional //Make comment required Option.CommentFieldRequired
This API will show users a form they can use to submit new feedback and suggestions.
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.
Updated 2 months ago