appcues/com.appcues/Appcues

Appcues

The main entry point for using Appcues functionality in your application - tracking analytics and rendering experiences.

Types

object Companion

Properties

analyticsListener

var analyticsListener: AnalyticsListener?

Sets the listener to be notified about published analytics.

experienceListener

var experienceListener: ExperienceListener?

Set the listener to be notified about the display of Experience content.

var interceptor: AppcuesInterceptor?

Set the interceptor for additional control over SDK runtime behaviors.

navigationHandler

var navigationHandler: NavigationHandler?

Sets the handler to use for link navigation.

val version: String

The current version of Appcues SDK.

Functions

fun anonymous()

Generate a unique Id for the current user when there is not a known identity to use in the {@link identity(String, Map) identity} call. This will cause the SDK to begin tracking activity and checking for qualified content.

fun debug(activity: Activity)

Starts the Appcues Debugger over the specified Activity.

fun group(groupId: String?, properties: Map<String, Any>? = null)

Identify a group for the current user.

fun identify(userId: String, properties: Map<String, Any>? = null)

Identify the user and determine if they should see Appcues content.

fun onNewIntent(activity: Activity, intent: Intent?): Boolean

Notify Appcues of a new Intent to check for deep link content. This should be used to pass along Intents that may be using the custom Appcues scheme, for things like previewing experiences.

fun registerEmbed(frameId: String, frame: AppcuesFrameView)

Register an AppcuesFrameView for a given frameId.

fun reset()

Clears out the current user in this session. Can be used when the user logs out of your application.

fun screen(title: String, properties: Map<String, Any>? = null)

Track an screen viewed by a user.

fun setPushToken(token: String?)

Provide the Firebase Cloud Messaging (FCM) device token to Appcues.

suspend fun show(experienceId: String): Boolean

Renders the specified Appcues experience for the current user.

fun stop()

Signals to Appcues that this instance should stop all ongoing jobs.

fun track(name: String, properties: Map<String, Any>? = null)

Track an action taken by a user.

fun trackScreens()

Enables automatic screen tracking for Activities.