cat.ereza.customactivityoncrash.config

Class CaocConfig.Builder

java.lang.Object

cat.ereza.customactivityoncrash.config.CaocConfig.Builder

Enclosing class:

CaocConfig

public static class CaocConfig.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
void	apply()
CaocConfig.Builder	backgroundMode(int backgroundMode) Defines if the error activity must be launched when the app is on background.
static CaocConfig.Builder	create()
CaocConfig.Builder	enabled(boolean enabled) Defines if CustomActivityOnCrash crash interception mechanism is enabled.
CaocConfig.Builder	errorActivity(java.lang.Class<? extends android.app.Activity> errorActivityClass) Sets the error activity class to launch when a crash occurs.
CaocConfig.Builder	errorDrawable(java.lang.Integer errorDrawable) Defines which drawable to use in the default error activity image.
CaocConfig.Builder	eventListener(CustomActivityOnCrash.EventListener eventListener) Sets an event listener to be called when events occur, so they can be reported by the app as, for example, Google Analytics events.
CaocConfig	get()
CaocConfig.Builder	logErrorOnRestart(boolean logErrorOnRestart) Defines if the stack trace must be logged again once the custom activity is shown.
CaocConfig.Builder	minTimeBetweenCrashesMs(int minTimeBetweenCrashesMs) Defines the time that must pass between app crashes to determine that we are not in a crash loop.
CaocConfig.Builder	restartActivity(java.lang.Class<? extends android.app.Activity> restartActivityClass) Sets the main activity class that the error activity must launch when a crash occurs.
CaocConfig.Builder	showErrorDetails(boolean showErrorDetails) Defines if the error activity must shown the error details button.
CaocConfig.Builder	showRestartButton(boolean showRestartButton) Defines if the error activity should show a restart button.
CaocConfig.Builder	trackActivities(boolean trackActivities) Defines if the activities visited by the user should be tracked so they are reported when an error occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

create

public static CaocConfig.Builder create()

backgroundMode

public CaocConfig.Builder backgroundMode(int backgroundMode)

Defines if the error activity must be launched when the app is on background. BackgroundMode.BACKGROUND_MODE_SHOW_CUSTOM: launch the error activity when the app is in background, BackgroundMode.BACKGROUND_MODE_CRASH: launch the default system error when the app is in background, BackgroundMode.BACKGROUND_MODE_SILENT: crash silently when the app is in background, The default is BackgroundMode.BACKGROUND_MODE_SHOW_CUSTOM (the app will be brought to front when a crash occurs).

enabled

public CaocConfig.Builder enabled(boolean enabled)

Defines if CustomActivityOnCrash crash interception mechanism is enabled. Set it to true if you want CustomActivityOnCrash to intercept crashes, false if you want them to be treated as if the library was not installed. The default is true.

showErrorDetails

public CaocConfig.Builder showErrorDetails(boolean showErrorDetails)

Defines if the error activity must shown the error details button. Set it to true if you want to show the full stack trace and device info, false if you want it to be hidden. The default is true.

showRestartButton

public CaocConfig.Builder showRestartButton(boolean showRestartButton)

Defines if the error activity should show a restart button. Set it to true if you want to show a restart button, false if you want to show a close button. Note that even if restart is enabled but you app does not have any launcher activities, a close button will still be used by the default error activity. The default is true.

logErrorOnRestart

public CaocConfig.Builder logErrorOnRestart(boolean logErrorOnRestart)

Defines if the stack trace must be logged again once the custom activity is shown. Set it to true if you want to log the stack trace again, false if you don't want the extra logging. This option exists because the default Android Studio logcat view only shows the output of the current process, and since the error activity runs on a new process, you can't see the previous output easily. Internally, it's logged when getConfigFromIntent() is called. The default is true.

trackActivities

public CaocConfig.Builder trackActivities(boolean trackActivities)

Defines if the activities visited by the user should be tracked so they are reported when an error occurs. The default is false.

minTimeBetweenCrashesMs

public CaocConfig.Builder minTimeBetweenCrashesMs(int minTimeBetweenCrashesMs)

Defines the time that must pass between app crashes to determine that we are not in a crash loop. If a crash has occurred less that this time ago, the error activity will not be launched and the system crash screen will be invoked. The default is 3000.

errorDrawable

public CaocConfig.Builder errorDrawable(java.lang.Integer errorDrawable)

Defines which drawable to use in the default error activity image. Set this if you want to use an image other than the default one. The default is R.drawable.customactivityoncrash_error_image (a cute upside-down bug).

errorActivity

public CaocConfig.Builder errorActivity(java.lang.Class<? extends android.app.Activity> errorActivityClass)

Sets the error activity class to launch when a crash occurs. If null, the default error activity will be used.

restartActivity

public CaocConfig.Builder restartActivity(java.lang.Class<? extends android.app.Activity> restartActivityClass)

Sets the main activity class that the error activity must launch when a crash occurs. If not set or set to null, the default launch activity will be used. If your app has no launch activities and this is not set, the default error activity will close instead.

eventListener

public CaocConfig.Builder eventListener(CustomActivityOnCrash.EventListener eventListener)

Sets an event listener to be called when events occur, so they can be reported by the app as, for example, Google Analytics events. If not set or set to null, no events will be reported.

Parameters:

eventListener - The event listener.

Throws:

java.lang.IllegalArgumentException - if the eventListener is an inner or anonymous class

get

public CaocConfig get()

apply

public void apply()