core/com.smartlook.android.core.api/Smartlook

Smartlook

SDK start point. Get instance, set your project key and start recording. Your preferences can be set in Smartlook webpage (Manage projects select one of your projects Project settings), or local in preferences. Current state is combination of your settings on the Smartlook webpage, default values and your local preferences. Navigation events and user interactions are tracked automatically but can be customized in preferences.eventTracking. If your application contains some sensitive Views, for example PIN keyboard or PAN label, these Views can be marked as sensitive in sensitivity and they will be covered in records. You can also track your own events by trackEvent. Recording can be started and stopped any time by start and stop.

    val smartlook = Smartlook.instance
    smartlook.preferences.projectKey = "YOUR_PROJECT_KEY"
    smartlook.start()

Types

Companion

object Companion

Functions

reset

fun reset()

Stops recording and resets preferences and setupConfiguration into the default state.

start

fun start()

Starts recording of a user activity. Data is uploaded only when valid Preferences.projectKey is present. It does not affect the Crash Report.

stop

fun stop()

Stops recording of a user activity. It does not affect the Crash Report.

trackEvent

@JvmOverloads

fun trackEvent(name: String, props: Properties? = null)

Tracks a custom event with optional properties. Recording must be started, otherwise the event will be dropped.

trackNavigationEnter

@JvmOverloads

fun trackNavigationEnter(name: String, props: Properties? = null)

Tracks Activity or Fragment entrance with optional properties. Recording must be started, otherwise the event will be dropped.

trackNavigationExit

@JvmOverloads

fun trackNavigationExit(name: String, props: Properties? = null)

Tracks Activity or Fragment exit with an optional properties. Enter with the same name must be called before exit. Recording must be started, otherwise the event will be dropped.

trackNetworkRequest

@JvmOverloads

fun trackNetworkRequest(request: SmartlookNetworkRequest, props: Properties? = null)

Tracks SmartlookNetworkRequest with an optional properties. Recording must be started, otherwise the event will be dropped.

Properties

eventProperties

val eventProperties: Properties

Map of properties that are included in every event.

log

val log: Log

SDK log settings.

preferences

val preferences: Preferences

Preferred configuration. The entered values represent only the preferred configuration. The resulting state may be different according to your account settings.

recordingMask

var recordingMask: RecordingMask?

Recording mask configuration defines which part of screen will not be visible. Used only when State.renderingMode is RenderingMode.NATIVE.

sensitivity

val sensitivity: Sensitivity

Sensitivity configuration defines which part of screen will not be visible. Used only when State.renderingMode is RenderingMode.NATIVE.

setupConfiguration

val setupConfiguration: SetupConfiguration

If is it necessary to change some values after start, the reset must be called to reset SDK into the default state.

state

val state: State

The current SDK state. Each value is combination of default one, account settings and preferences.

user

val user: User

A user's data contained in the record.