com.buglife.sdk

Class Buglife

java.lang.Object

com.buglife.sdk.Buglife

public final class Buglife
extends java.lang.Object

Buglife! Handles initialization and configuration of Buglife.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Buglife.BuglifeException

Method Summary

Modifier and Type	Method and Description
static void	addAttachment(Attachment attachment) Queues an attachment for the next bug report draft.
static void	addAttachment(FileAttachment attachment) Queues a file attachment for the next bug report draft.
static FileAttachment	captureScreenshot() Captures a screenshot of the current activity.
static InvocationMethod	getInvocationMethod()
static RetryPolicy	getRetryPolicy() Gets the current retry policy .
static android.graphics.Bitmap	getScreenshotBitmap() Deprecated.
static java.lang.String	getUserEmail() Returns any user email address that has been set, if any
static java.lang.String	getUserIdentifier() Returns any user identifier than has been set, if any
static void	initWithApiKey(android.app.Application application, java.lang.String apiKey) Enables Buglife bug reporting within your app.
static void	initWithEmail(android.app.Application application, java.lang.String email) Call this method with your own email address if you'd like to try out Buglife without signing up for an account.
static void	putAttribute(java.lang.String key, java.lang.String value) Adds custom data to bug reports.
static void	setInputFields(InputField... inputFields) Configures the input fields to be shown in the bug reporter UI.
static void	setInvocationMethod(InvocationMethod invocationMethod) Specifies the method for which users initiate the Buglife bug report flow.
static void	setListener(BuglifeListener listener) Sets a listener for Buglife-related callbacks.
static void	setRetryPolicy(RetryPolicy retryPolicy) Specifies the retry policy when submitting bug reports.
static void	setUserEmail(java.lang.String userEmail) Specifies an email for the user that will be submitted with bug reports.
static void	setUserIdentifier(java.lang.String userIdentifier) Specifies a user identifier that will be submitted with bug reports.
static void	showReporter() Manually presents the bug reporter UI.
static void	startScreenRecording() Manually starts the screen recording flow; users can record up to 30 seconds, or tap the record button to stop recording early.

Methods inherited from class java.lang.Object

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

Method Detail

initWithApiKey

public static void initWithApiKey(android.app.Application application,
                                  java.lang.String apiKey)

Enables Buglife bug reporting within your app. This method should be called from the onCreate() method in your Application subclass. If your project doesn't already have a custom Application subclass, you'll need to create one.

Parameters:

application - Your application subclass, usually this

apiKey - Your Buglife API key. You can find this on the Buglife web dashboard

initWithEmail

public static void initWithEmail(android.app.Application application,
                                 java.lang.String email)

Call this method with your own email address if you'd like to try out Buglife without signing up for an account. Bug reports will be sent directly to the provided email. This method should be called from the onCreate() method in your Application subclass. If your project doesn't already have a custom Application subclass, you'll need to create one.

Parameters:

application - Your application subclass, usually this

email - The email address to which bug reports should be sent. This email address should belong to you or someone on your team.

setInvocationMethod

public static void setInvocationMethod(InvocationMethod invocationMethod)

Specifies the method for which users initiate the Buglife bug report flow.

Parameters:

invocationMethod - The invocation method

getInvocationMethod

public static InvocationMethod getInvocationMethod()

setUserIdentifier

public static void setUserIdentifier(java.lang.String userIdentifier)

Specifies a user identifier that will be submitted with bug reports. This can be a name, database identifier, or any other string of your choosing.

Parameters:

userIdentifier - The user identifier.

getUserIdentifier

public static java.lang.String getUserIdentifier()

Returns any user identifier than has been set, if any

Returns:

the user identifier or null (default)

setUserEmail

public static void setUserEmail(java.lang.String userEmail)

Specifies an email for the user that will be submitted with bug reports.

Parameters:

userEmail - The user email.

getUserEmail

public static java.lang.String getUserEmail()

Returns any user email address that has been set, if any

Returns:

the user email or null (default)

getScreenshotBitmap

@Deprecated
public static android.graphics.Bitmap getScreenshotBitmap()

Deprecated.

Captures a screenshot of the current activity. Deprecated, use captureScreenshot() instead.

Returns:

A bitmap of the generated screenshot

captureScreenshot

public static FileAttachment captureScreenshot()

Captures a screenshot of the current activity.

Returns:

A File that represents the screenshot. If screenshot failed, this will return null.

addAttachment

public static void addAttachment(Attachment attachment)

Queues an attachment for the next bug report draft.

Parameters:

attachment - The attachment

addAttachment

public static void addAttachment(FileAttachment attachment)

Queues a file attachment for the next bug report draft.

Parameters:

attachment - The attachment

putAttribute

public static void putAttribute(java.lang.String key,
                                java.lang.String value)

Adds custom data to bug reports. Set a `null` value for a given attribute to delete its current value. Custom attributes are not automatically cleared after a bug report is submitted.

Parameters:

key - The attribute key

value - The attribute value

setInputFields

public static void setInputFields(InputField... inputFields)

Configures the input fields to be shown in the bug reporter UI.

Parameters:

inputFields - The input fields

setListener

public static void setListener(BuglifeListener listener)

Sets a listener for Buglife-related callbacks.

Parameters:

listener - The listener

showReporter

public static void showReporter()

Manually presents the bug reporter UI.

startScreenRecording

public static void startScreenRecording()

Manually starts the screen recording flow; users can record up to 30 seconds, or tap the record button to stop recording early. Once screen recording has been stopped, the bug reporter UI will be shown with the screen recording attached.

getRetryPolicy

public static RetryPolicy getRetryPolicy()

Gets the current retry policy .

setRetryPolicy

public static void setRetryPolicy(RetryPolicy retryPolicy)

Specifies the retry policy when submitting bug reports.

Parameters:

retryPolicy - The retry policy