bugbattle.io.bugbattle

Class BugBattle

java.lang.Object

bugbattle.io.bugbattle.BugBattle

public class BugBattle
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BugBattle.SEVERITY

Method Summary

Modifier and Type	Method and Description
static void	attachCustomData(org.json.JSONObject customData) Attach cusom data, which can be view in the BugBattle dashboard.
static void	attachData(org.json.JSONObject data) Attach Data to the request.
static void	enablePrivacyPolicy(boolean enable) Enables the privacy policy check.
static void	enableReplay() Enable Replay function for BB Use with care, check performance on phone
static BugBattle	initialise(java.lang.String sdkKey, BugBattleActivationMethod[] activationMethods, android.app.Application application) Initialises the Bugbattle SDK.
static BugBattle	initialise(java.lang.String sdkKey, BugBattleActivationMethod[] activationMethods, android.app.Application application, android.app.Activity activity) Initialises the Bugbattle SDK.
static BugBattle	initialise(java.lang.String sdkKey, BugBattleActivationMethod activationMethod, android.app.Application application) Initialises the Bugbattle SDK.
static void	logNetwork(java.lang.String urlConnection, RequestType requestType, int status, int duration, org.json.JSONObject request, org.json.JSONObject response) Log network traffic by logging it manually.
static void	sendSilentBugReport(java.lang.String email, java.lang.String description, BugBattle.SEVERITY severity) Send a silent bugreport in the background.
static void	setApiURL(java.lang.String apiUrl) Sets the API url to your internal Bugbattle server.
static void	setApplicationType(APPLICATIONTYPE applicationType) Set Application Type
static void	setBitmapCallback(GetBitmapCallback getBitmapCallback) Customize the way, the Bitmap is generated.
static void	setBugSentCallback(BugSentCallback bugSentCallback) This method is triggered, when the bugbattle flow is closed
static void	setBugWillBeSentCallback(BugWillBeSentCallback bugWillBeSentCallback) This is called, when the bugbattle flow is started
static void	setCustomerEmail(java.lang.String email) Set/Prefill the email address for the user.
static void	setLanguage(java.lang.String language) Set the language for the BugBattle Report Flow.
static void	setPrivacyPolicyUrl(java.lang.String privacyUrl) Sets a custom privacy policy url.
static void	startBugReporting() Manually start the bug reporting workflow.
static void	startBugReporting(android.graphics.Bitmap bitmap) Starts the bug reporting with a custom screenshot attached.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initialise

public static BugBattle initialise(java.lang.String sdkKey,
                                   BugBattleActivationMethod[] activationMethods,
                                   android.app.Application application,
                                   android.app.Activity activity)

Initialises the Bugbattle SDK.

Parameters:

application - The application (this)

sdkKey - The SDK key, which can be found on dashboard.bugbattle.io

activationMethods - Activation method, which triggers a new bug report.

activity - main activity

initialise

public static BugBattle initialise(java.lang.String sdkKey,
                                   BugBattleActivationMethod[] activationMethods,
                                   android.app.Application application)

Initialises the Bugbattle SDK.

Parameters:

application - The application (this)

sdkKey - The SDK key, which can be found on dashboard.bugbattle.io

activationMethods - Activation method, which triggers a new bug report.

initialise

public static BugBattle initialise(java.lang.String sdkKey,
                                   BugBattleActivationMethod activationMethod,
                                   android.app.Application application)

Initialises the Bugbattle SDK.

Parameters:

application - The application (this)

sdkKey - The SDK key, which can be found on dashboard.bugbattle.io

activationMethod - Activation method, which triggers a new bug report.

startBugReporting

public static void startBugReporting()
                              throws BugBattleNotInitialisedException

Manually start the bug reporting workflow. This is used, when you use the activation method "NONE".

Throws:

BugBattleNotInitialisedException - thrown when BugBattle is not initialised

startBugReporting

public static void startBugReporting(android.graphics.Bitmap bitmap)

Starts the bug reporting with a custom screenshot attached.

Parameters:

bitmap - the image will be used instead of the current

attachCustomData

public static void attachCustomData(org.json.JSONObject customData)

Attach cusom data, which can be view in the BugBattle dashboard.

Parameters:

customData - The data to attach to a bug report

setCustomerEmail

public static void setCustomerEmail(java.lang.String email)

Set/Prefill the email address for the user.

Parameters:

email - address, which is fileld in.

enablePrivacyPolicy

public static void enablePrivacyPolicy(boolean enable)

Enables the privacy policy check.

Parameters:

enable - Enable the privacy policy.

setPrivacyPolicyUrl

public static void setPrivacyPolicyUrl(java.lang.String privacyUrl)

Sets a custom privacy policy url.

Parameters:

privacyUrl - The URL pointing to your privacy policy.

setApiURL

public static void setApiURL(java.lang.String apiUrl)

Sets the API url to your internal Bugbattle server. Please make sure that the server is reachable within the network If you use a http url pls add android:usesCleartextTraffic="true" to your main activity to allow cleartext traffic

Parameters:

apiUrl - url of the internal Bugbattle server

setBugWillBeSentCallback

public static void setBugWillBeSentCallback(BugWillBeSentCallback bugWillBeSentCallback)

This is called, when the bugbattle flow is started

Parameters:

bugWillBeSentCallback - is called when BB is opened

setBugSentCallback

public static void setBugSentCallback(BugSentCallback bugSentCallback)

This method is triggered, when the bugbattle flow is closed

Parameters:

bugSentCallback - this callback is called when the flow is called

setBitmapCallback

public static void setBitmapCallback(GetBitmapCallback getBitmapCallback)

Customize the way, the Bitmap is generated. If this is overritten, only the custom way is used

Parameters:

getBitmapCallback - get the Bitmap

setApplicationType

public static void setApplicationType(APPLICATIONTYPE applicationType)

Set Application Type

Parameters:

applicationType - "Android", "RN", "Flutter"

enableReplay

public static void enableReplay()

Enable Replay function for BB Use with care, check performance on phone

setLanguage

public static void setLanguage(java.lang.String language)

Set the language for the BugBattle Report Flow. Otherwise the default language is used. Supported Languages "en", "es", "fr", "it", "de", "nl"

Parameters:

language - ISO Country Code eg. "en", "de", "es", "nl"

attachData

public static void attachData(org.json.JSONObject data)

Attach Data to the request. The Data will be merged into the body sent with the bugreport. !!Existing keys can be overriten

Parameters:

data - Data, which is added

logNetwork

public static void logNetwork(java.lang.String urlConnection,
                              RequestType requestType,
                              int status,
                              int duration,
                              org.json.JSONObject request,
                              org.json.JSONObject response)

Log network traffic by logging it manually.

Parameters:

urlConnection - URL where the request is sent to

requestType - GET, POST, PUT, DELETE

status - status of the response (e.g. 200, 404)

duration - duration of the request

request - Add the data you want. e.g the body sent in the request

response - Response of the call. You can add just the information you want and need.

sendSilentBugReport

public static void sendSilentBugReport(java.lang.String email,
                                       java.lang.String description,
                                       BugBattle.SEVERITY severity)

Send a silent bugreport in the background. Useful for automated ui tests.

Parameters:

email - who sent the bug report

description - description of the bug

severity - Severity of the bug "LOW", "MIDDLE", "HIGH"