braze-android-sdk/com.braze.support/BrazeLogger

BrazeLogger

object BrazeLogger

Wraps Log so that Braze log messages can be set to a configurable level.

Types

enum Priority : Enum<BrazeLogger.Priority>

Functions

fun Any.brazelog(priority: BrazeLogger.Priority = D, tr: Throwable? = null, message: () -> String)

Sends a log message from a class.

fun brazelog(tag: String, priority: BrazeLogger.Priority = D, tr: Throwable? = null, message: () -> String)

Sends a log message outside of a class (or to specify a tag explicitly). Tag should also be specified when using within a coroutine.

fun Any.brazeLogTag(): String

Generates a tag for a class.

checkForSystemLogLevelProperty

fun checkForSystemLogLevelProperty(returnOnDebug: Boolean = true)

Internal Braze method. Do not use.

fun d(tag: String, msg: String, tr: Throwable? = null)

Sends a debug log message.

fun e(tag: String, msg: String, tr: Throwable)

Sends an error level log message.

fun String.getBrazeLogTag(): String

Gets the Braze log tag from a String.

fun getBrazeLogTag(classForTag: Class<*>): String

Returns a Log tag string prepended with the Braze SDK version and appended with Class.getName. The class name will be shortened to a logcat appropriate length.

fun i(tag: String, msg: String, tr: Throwable? = null)

Sends an info level log message.

resetForTesting

fun resetForTesting()

setInitialLogLevelFromConfiguration

fun setInitialLogLevelFromConfiguration(initialLogLevel: Int)

Sets the log level if no log level was ever set via BrazeLogger.logLevel. The purpose of this method is allow for the safe setting of an initial configuration value while not overriding any log level calls made in code before the SDK was initialized.

fun v(tag: String, msg: String, tr: Throwable? = null)

Sends a verbose log message.

fun w(tag: String, msg: String, tr: Throwable? = null)

Sends an warn level log message.

Properties

@set:Synchronized

var logLevel: Int

Sets the log level used for logging messages from the Braze SDK.

onLoggedCallback

var onLoggedCallback: (priority: BrazeLogger.Priority, message: String, throwable: Throwable?) -> Unit? = null

A callback function fired whenever a log is made from this class. Does not perform any filtering based on logLevel.

const val SUPPRESS: Int

const val VERBOSE: Int