Customizations

SDK

Initialize the SDK

To initialize the BugBattle SDK, you need to add the following code to the end of the applicationDidFinishLaunchingWithOptions delegate.

BugBattle.initWithToken("YOUR-API-KEY", andActivationMethod: SHAKE)

Your API key can be found in the project settings within BugBattle. Possible values for the activation method are NONE, SHAKE and THREE_FINGER_DOUBLE_TAB.

BugBattle.NONE: No automatic activation.

BugBattle.SHAKE: Activation on device shake.

BugBattle.THREE_FINGER_DOUBLE_TAB: Activation on double tapping with three fingers.

BugBattle.SCREENSHOT: Activation when user performs a screenshot trigger.

Manually initiate the bug reporting flow

Some situations require more control about the activation of the bug reporting flow. By calling the startBugReporting method, you can simply start the flow manually. In order to also prevent the shake gesture, just initialize the Bugbattle SDK with the activation method NONE.

BugBattle.startBugReporting()

Attach a custom screenshot

Starts the bug reporting with a custom screenshot attached.

BugBattle.startBugReporting(withScreenshot: awesomeImage)

Customer email address

Sets the customer's email address.

BugBattle.setCustomerEmail("hello@bugbattle.io")

Attach custom data

Sometimes you need to attach custom data to bug reports in order to solve them more quickly. Any simple dictionary can be attached.

BugBattle.attachCustomData(["aKey": "containsAwesomeData"])

Privacy policy

Enable privacy policy check

Enables the privacy policy check within the bug reporting flow. With this option set to true, users must accept the privacy policy in order to send a bug report.

BugBattle.enablePrivacyPolicy(true)

Privacy policy url

Sets the privacy policy url. This is especially handy if you have any special requirements regarding the privacy policy. The default url is set to the Bugbattle privacy policy.

BugBattle.setPrivacyPolicyUrl("https://awesomeproject.com/privacypolicy")

Styling

NavigationBar Tint Color

Sets the NavigationBar tint color. Accepts an UIColor.

BugBattle.setNavigationBarTint(UIColor.blue)

Navigation Tint Color

Sets the Navigation tint color. Accepts an UIColor.

BugBattle.setNavigationTint(UIColor.white)

NavigationBarTitle Color

Sets the NavigationBarTitle color. Accepts an UIColor.

BugBattle.setNavigationBarTitleColor(UIColor.white)

Self-Hosted

API url

Sets the API url to your internal Bugbattle server. Please make sure that the server is reachable within the network.

BugBattle.setApiUrl("https://internalbugbattle.server")