com.crashlytics.android.core

Class CrashlyticsCore

Object

io.fabric.sdk.android.Kit<Void>

com.crashlytics.android.core.CrashlyticsCore

All Implemented Interfaces:

Comparable<io.fabric.sdk.android.Kit>

public class CrashlyticsCore
extends io.fabric.sdk.android.Kit<Void>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CrashlyticsCore.Builder Fluent API for creating CrashlyticsCore instances.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG

Constructor Summary

Constructors

Constructor and Description
CrashlyticsCore()

Method Summary

Modifier and Type	Method and Description
void	crash() The easiest way to cause a crash - great for testing!
protected Void	doInBackground()
String	getIdentifier()
static CrashlyticsCore	getInstance()
PinningInfoProvider	getPinningInfoProvider()
String	getVersion()
void	log(int priority, String tag, String msg) Add text logging that will be sent with your next report, using log(String).
void	log(String msg) Add text logging that will be sent with your next report.
void	logException(Throwable throwable) Logs a non-fatal Throwable on the Crashlytics servers.
protected boolean	onPreExecute()
void	setBool(String key, boolean value) Sets a value to be associated with a given key for your crash data.
void	setDouble(String key, double value) Sets a value to be associated with a given key for your crash data.
void	setFloat(String key, float value) Sets a value to be associated with a given key for your crash data.
void	setInt(String key, int value) Sets a value to be associated with a given key for your crash data.
void	setListener(CrashlyticsListener listener) Deprecated. use CrashlyticsCore.Builder.listener(CrashlyticsListener) instead
void	setLong(String key, long value) Sets a value to be associated with a given key for your crash data.
void	setString(String key, String value) Set a value to be associated with a given key for your crash data.
void	setUserEmail(String email) Optionally set a end-user's name or username for display within the Crashlytics UI.
void	setUserIdentifier(String identifier) Many of our customers have requested the ability to tie crashes to specific end-users of their application in order to facilitate responses to support requests or permit the ability to reach out for more information.
void	setUserName(String name) Optionally set a end-user's name or username for display within the Crashlytics UI.
boolean	verifyPinning(URL url) Helper method to verify SSL pinning is properly configured.

Methods inherited from class io.fabric.sdk.android.Kit

compareTo, getContext, getDependencies, getFabric, getIdManager, getPath, onCancelled, onPostExecute

Methods inherited from class Object

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

Field Detail

TAG

public static final String TAG

See Also:

Constant Field Values

Constructor Detail

CrashlyticsCore

public CrashlyticsCore()

Method Detail

onPreExecute

protected boolean onPreExecute()

Overrides:

onPreExecute in class io.fabric.sdk.android.Kit<Void>

doInBackground

protected Void doInBackground()

Specified by:

doInBackground in class io.fabric.sdk.android.Kit<Void>

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in class io.fabric.sdk.android.Kit<Void>

getVersion

public String getVersion()

Specified by:

getVersion in class io.fabric.sdk.android.Kit<Void>

getInstance

public static CrashlyticsCore getInstance()

Returns:

the CrashlyticsCore singleton.

getPinningInfoProvider

public PinningInfoProvider getPinningInfoProvider()

logException

public void logException(Throwable throwable)

Logs a non-fatal Throwable on the Crashlytics servers. Crashlytics will analyze the Throwable and create a new issue or add it to an existing issue, as appropriate. To ensure accurate reporting, this method must be invoked from the thread on which the Throwable was thrown. The Throwable will always be processed on a background thread, so it is safe to invoke this method from the main thread.

log

public void log(String msg)

Add text logging that will be sent with your next report. This logging will only be visible in your Crashlytics dashboard, and will be associated with the next crash or logged exception for this app execution. Newline characters ('\n') will be stripped from msg. The log is rolling with a maximum size of 64k, such that messages are removed (oldest first) if the max size is exceeded.

See Also:

logException(Throwable)

log

public void log(int priority,
                String tag,
                String msg)

Add text logging that will be sent with your next report, using log(String). The message will also be printed to LogCat using android.util.Log.println(priority, tag, msg).

Parameters:

priority - The priority/type constant of this log message, as defined in android.util.Log. One of: ERROR, WARN, INFO, DEBUG, VERBOSE.

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

See Also:

log(String), Log.println(int, String, String)

setUserIdentifier

public void setUserIdentifier(String identifier)

Many of our customers have requested the ability to tie crashes to specific end-users of their application in order to facilitate responses to support requests or permit the ability to reach out for more information. We allow you to specify up to three separate values for display within the Crashlytics UI - but please be mindful of your end-user's privacy. We recommend specifying a user identifier - an arbitrary string that ties an end-user to a record in your system. This could be a database id, hash, or other value that is meaningless to a third-party observer but can be indexed and queried by you. Optionally, you may also specify the end-user's name or username, as well as email address if you do not have a system that works well with obscured identifiers. Pursuant to our EULA, this data is transferred securely throughout our system and we will not disseminate end-user data unless required to by law. That said, if you choose to provide end-user contact information, we strongly recommend that you disclose this in your application's privacy policy. Data privacy is of our utmost concern. Any user identifier information longer than 1024 characters will be truncated.

setUserName

public void setUserName(String name)

Optionally set a end-user's name or username for display within the Crashlytics UI.

See Also:

for more information.

setUserEmail

public void setUserEmail(String email)

Optionally set a end-user's name or username for display within the Crashlytics UI.

See Also:

for more information.

setString

public void setString(String key,
                      String value)

Set a value to be associated with a given key for your crash data. The key/value pairs will be reported with any crash that occurs in this session. A maximum of 64 key/value pairs can be stored for any type. New keys added over that limit will be ignored. Keys and values are trimmed (String.trim()), and keys or values that exceed 1024 characters will be truncated.

Throws:

NullPointerException - if key is null.

setBool

public void setBool(String key,
                    boolean value)

Sets a value to be associated with a given key for your crash data.

See Also:

setString(String,String)

setDouble

public void setDouble(String key,
                      double value)

Sets a value to be associated with a given key for your crash data.

See Also:

setString(String,String)

setFloat

public void setFloat(String key,
                     float value)

Sets a value to be associated with a given key for your crash data.

See Also:

setString(String,String)

setInt

public void setInt(String key,
                   int value)

Sets a value to be associated with a given key for your crash data.

See Also:

setString(String,String)

setLong

public void setLong(String key,
                    long value)

Sets a value to be associated with a given key for your crash data.

See Also:

setString(String,String)

crash

public void crash()

The easiest way to cause a crash - great for testing!

verifyPinning

public boolean verifyPinning(URL url)

Helper method to verify SSL pinning is properly configured. This method is most appropriately used during testing and not production, as Fabric.with must be invoked prior to executing.

Returns:

true if PinningInfoProvider is assigned and a GET to the given URL returns a 200-range response, false otherwise. It will not throw an exception although the exception will be logged as an error.

setListener

@Deprecated
public void setListener(CrashlyticsListener listener)

Deprecated. use CrashlyticsCore.Builder.listener(CrashlyticsListener) instead