FirebaseCrashlytics Framework Reference

CrashlyticsReport

class CrashlyticsReport : NSObject

The Firebase Crashlytics Report provides a way to read and write information to a past Crashlytics reports. A common use case is gathering end-user feedback on the next run of the app.

The CrashlyticsReport should be modified before calling send/deleteUnsentReports.

• reportID

  Returns the unique ID for the Crashlytics report.

  Declaration

  Swift

  var reportID: String { get }

• dateCreated

  Returns the date that the report was created.

  Declaration

  Swift

  var dateCreated: Date { get }

• hasCrash

  Returns true when one of the events in the Crashlytics report is a crash.

  Declaration

  Swift

  var hasCrash: Bool { get }

• log(_:)

  Adds logging that is sent with your crash data. The logging does not appear in the system.log and is only visible in the Crashlytics dashboard.

  Declaration

  Swift

  func log(_ msg: String)

  Parameters

  msg	Message to log

• -logWithFormat:

  Adds logging that is sent with your crash data. The logging does not appear in the system.log and is only visible in the Crashlytics dashboard.

  Parameters

  format

  The format of the string, followed by a comma-separated list of arguments to substitute into the format.

• log(format:arguments:)

  Adds logging that is sent with your crash data. The logging does not appear in the system.log and is only visible in the Crashlytics dashboard.

  Declaration

  Swift

  func log(format: String, arguments args: CVaListPointer)

  Parameters

  format	Format of string
  args	Arguments to substitute into format

• setCustomValue(_:forKey:)

  Sets a custom key and value to be associated with subsequent fatal and non-fatal reports. When setting an object value, the object is converted to a string. This is typically done by using the object’s description.

  Declaration

  Swift

  func setCustomValue(_ value: Any?, forKey key: String)

  Parameters

  value	The value to be associated with the key
  key	A unique key

• setCustomKeysAndValues(_:)

  Sets custom keys and values to be associated with subsequent fatal and non-fatal reports. The objects in the dictionary are converted to strings. This is typically done by using the object’s description.

  Declaration

  Swift

  func setCustomKeysAndValues(_ keysAndValues: [AnyHashable : Any])

  Parameters

  keysAndValues

  The values to be associated with the corresponding keys

• setUserID(_:)

  Records a user ID (identifier) that’s associated with subsequent fatal and non-fatal reports.

  If you want to associate a crash with a specific user, we recommend specifying an arbitrary string (e.g., a database, ID, hash, or other value that you can index and query, but is meaningless to a third-party observer). This allows you to facilitate responses for support requests and reach out to users for more information.

  Declaration

  Swift

  func setUserID(_ userID: String?)

  Parameters

  userID

  An arbitrary user identifier string that associates a user to a record in your system.