appcues/com.appcues

Package-level declarations

Types

AnalyticsListener

interface AnalyticsListener

Provides a method to listen for analytics that have been published.

AnalyticType

enum AnalyticType : Enum<AnalyticType>

Represents the different types of analytics that can be reported.

Appcues

class Appcues

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

AppcuesConfig

data class AppcuesConfig

A configuration object that defines the behavior and policies for Appcues.

AppcuesCustomComponentView

interface AppcuesCustomComponentView

AppcuesCustomComponentView is an interface to be implemented when registering a new custom component linked to an identifier.

AppcuesExperienceActions

interface AppcuesExperienceActions

AppcuesExperienceActions is the controller that allows custom component access useful appcues and experience calls.

AppcuesFirebaseMessagingService

class AppcuesFirebaseMessagingService : FirebaseMessagingService

Appcues Firebase Messaging Service implementation.

AppcuesFrameView

class AppcuesFrameView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout

AppcuesFrameView should be used when customers want to define a specific place for inflating Embed content in their app. By placing an AppcuesFrameView in their layout, then can later register this view with a frameId.

AppcuesInterceptor

interface AppcuesInterceptor

An interceptor that can optionally be applied during initialization to control Appcues behaviors at runtime.

AppcuesProviderService

object AppcuesProviderService

Allows programmatic access to start and stop services normally controlled through an androidx.startup.InitializationProvider. In most typical use cases, this access is not expected to be necessary, and these services will start automatically.

ElementSelector

interface ElementSelector

Defines a type to identify view elements with a set of selector properties.

ElementTargetingStrategy

interface ElementTargetingStrategy

Defines an element targeting strategy type, which can be used to capture view layout information in the application UI as well as render element targeted experiences.

ExperienceListener

interface ExperienceListener

A listener that informs about Experience content being rendered inside of the application.

LoggingLevel

enum LoggingLevel : Enum<LoggingLevel>

Determines the level of output from the Appcues to Logcat.

NavigationHandler

interface NavigationHandler

An handler that can be supplied by the host application to control behaviors around link navigation.

Screenshot

data class Screenshot(val bitmap: Bitmap, val size: Size, val insets: Insets)

Contains the information about the screenshot image capture.

ViewElement

@JsonClass(generateAdapter = true)

data class ViewElement(val id: UUID = UUID.randomUUID(), val x: Int, val y: Int, val width: Int, val height: Int, val type: String, val displayName: String?, val selector: ElementSelector?, val children: List<ViewElement>?)

Represents a view in the layout hierarchy of the application.

Functions

Appcues

fun Appcues(context: Context, accountId: String, applicationId: String, config: AppcuesConfig.() -> Unit? = null): Appcues

Construct and return an instance of the Appcues SDK.

AppcuesFrame

@Composable

fun AppcuesFrame(modifier: Modifier = Modifier, appcues: Appcues, frameId: String)

A Compose view that displays an Appcues experience.

appcuesView

@Stable

fun Modifier.appcuesView(tag: String): Modifier

Identify this composable as a view to be available to Appcues targeted element experiences.

isAppcuesView

fun View.isAppcuesView(): Boolean

Determine if a View was created by the Appcues SDK, such as the Debugger View, for example.