From 006b22f01c6e217e631824a8149e1cd6bec4c58f Mon Sep 17 00:00:00 2001 From: James Ellis Date: Fri, 26 Jan 2024 11:36:43 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20compiled=20docs=20for?= =?UTF-8?q?=203.1.9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/appcues/com.appcues/-analytic-type/-e-v-e-n-t/index.html | 2 +- docs/appcues/com.appcues/-analytic-type/-g-r-o-u-p/index.html | 2 +- .../com.appcues/-analytic-type/-i-d-e-n-t-i-f-y/index.html | 2 +- docs/appcues/com.appcues/-analytic-type/-s-c-r-e-e-n/index.html | 2 +- docs/appcues/com.appcues/-analytic-type/index.html | 2 +- docs/appcues/com.appcues/-analytic-type/value-of.html | 2 +- docs/appcues/com.appcues/-analytic-type/values.html | 2 +- docs/appcues/com.appcues/-analytics-listener/index.html | 2 +- .../com.appcues/-analytics-listener/tracked-analytic.html | 2 +- .../com.appcues/-appcues-config/activity-storage-max-age.html | 2 +- .../com.appcues/-appcues-config/activity-storage-max-size.html | 2 +- .../com.appcues/-appcues-config/additional-auto-properties.html | 2 +- .../appcues/com.appcues/-appcues-config/analytics-listener.html | 2 +- .../com.appcues/-appcues-config/anonymous-id-factory.html | 2 +- docs/appcues/com.appcues/-appcues-config/api-base-path.html | 2 +- .../com.appcues/-appcues-config/experience-listener.html | 2 +- docs/appcues/com.appcues/-appcues-config/index.html | 2 +- docs/appcues/com.appcues/-appcues-config/interceptor.html | 2 +- docs/appcues/com.appcues/-appcues-config/logging-level.html | 2 +- .../appcues/com.appcues/-appcues-config/navigation-handler.html | 2 +- docs/appcues/com.appcues/-appcues-config/session-timeout.html | 2 +- .../com.appcues/-appcues-frame-view/-appcues-frame-view.html | 2 +- docs/appcues/com.appcues/-appcues-frame-view/index.html | 2 +- docs/appcues/com.appcues/-appcues-frame.html | 2 +- .../-appcues-interceptor/can-display-experience.html | 2 +- docs/appcues/com.appcues/-appcues-interceptor/index.html | 2 +- docs/appcues/com.appcues/-appcues-provider-service/index.html | 2 +- docs/appcues/com.appcues/-appcues-provider-service/start.html | 2 +- docs/appcues/com.appcues/-appcues-provider-service/stop.html | 2 +- docs/appcues/com.appcues/-appcues.html | 2 +- .../com.appcues/-appcues/-companion/element-targeting.html | 2 +- docs/appcues/com.appcues/-appcues/-companion/index.html | 2 +- docs/appcues/com.appcues/-appcues/-companion/version.html | 2 +- docs/appcues/com.appcues/-appcues/analytics-listener.html | 2 +- docs/appcues/com.appcues/-appcues/anonymous.html | 2 +- docs/appcues/com.appcues/-appcues/debug.html | 2 +- docs/appcues/com.appcues/-appcues/experience-listener.html | 2 +- docs/appcues/com.appcues/-appcues/group.html | 2 +- docs/appcues/com.appcues/-appcues/identify.html | 2 +- docs/appcues/com.appcues/-appcues/index.html | 2 +- docs/appcues/com.appcues/-appcues/interceptor.html | 2 +- docs/appcues/com.appcues/-appcues/navigation-handler.html | 2 +- docs/appcues/com.appcues/-appcues/on-new-intent.html | 2 +- docs/appcues/com.appcues/-appcues/register-embed.html | 2 +- docs/appcues/com.appcues/-appcues/reset.html | 2 +- docs/appcues/com.appcues/-appcues/screen.html | 2 +- docs/appcues/com.appcues/-appcues/show.html | 2 +- docs/appcues/com.appcues/-appcues/stop.html | 2 +- docs/appcues/com.appcues/-appcues/track-screens.html | 2 +- docs/appcues/com.appcues/-appcues/track.html | 2 +- docs/appcues/com.appcues/-appcues/version.html | 2 +- docs/appcues/com.appcues/-element-selector/evaluate-match.html | 2 +- docs/appcues/com.appcues/-element-selector/index.html | 2 +- docs/appcues/com.appcues/-element-selector/to-map.html | 2 +- .../com.appcues/-element-targeting-strategy/capture-layout.html | 2 +- .../-element-targeting-strategy/capture-screenshot.html | 2 +- docs/appcues/com.appcues/-element-targeting-strategy/index.html | 2 +- .../-element-targeting-strategy/inflate-selector-from.html | 2 +- .../com.appcues/-experience-listener/experience-finished.html | 2 +- .../com.appcues/-experience-listener/experience-started.html | 2 +- docs/appcues/com.appcues/-experience-listener/index.html | 2 +- docs/appcues/com.appcues/-logging-level/-d-e-b-u-g/index.html | 2 +- docs/appcues/com.appcues/-logging-level/-i-n-f-o/index.html | 2 +- docs/appcues/com.appcues/-logging-level/-n-o-n-e/index.html | 2 +- docs/appcues/com.appcues/-logging-level/index.html | 2 +- docs/appcues/com.appcues/-logging-level/value-of.html | 2 +- docs/appcues/com.appcues/-logging-level/values.html | 2 +- docs/appcues/com.appcues/-navigation-handler/index.html | 2 +- docs/appcues/com.appcues/-navigation-handler/navigate-to.html | 2 +- docs/appcues/com.appcues/-screenshot/-screenshot.html | 2 +- docs/appcues/com.appcues/-screenshot/bitmap.html | 2 +- docs/appcues/com.appcues/-screenshot/index.html | 2 +- docs/appcues/com.appcues/-screenshot/insets.html | 2 +- docs/appcues/com.appcues/-screenshot/size.html | 2 +- docs/appcues/com.appcues/-view-element/-view-element.html | 2 +- docs/appcues/com.appcues/-view-element/children.html | 2 +- docs/appcues/com.appcues/-view-element/display-name.html | 2 +- docs/appcues/com.appcues/-view-element/height.html | 2 +- docs/appcues/com.appcues/-view-element/id.html | 2 +- docs/appcues/com.appcues/-view-element/index.html | 2 +- docs/appcues/com.appcues/-view-element/selector.html | 2 +- docs/appcues/com.appcues/-view-element/type.html | 2 +- docs/appcues/com.appcues/-view-element/width.html | 2 +- docs/appcues/com.appcues/-view-element/x.html | 2 +- docs/appcues/com.appcues/-view-element/y.html | 2 +- docs/appcues/com.appcues/appcues-view.html | 2 +- docs/appcues/com.appcues/index.html | 2 +- docs/appcues/com.appcues/is-appcues-view.html | 2 +- docs/index.html | 2 +- 89 files changed, 89 insertions(+), 89 deletions(-) diff --git a/docs/appcues/com.appcues/-analytic-type/-e-v-e-n-t/index.html b/docs/appcues/com.appcues/-analytic-type/-e-v-e-n-t/index.html index 504634a20..6f8d8a5eb 100644 --- a/docs/appcues/com.appcues/-analytic-type/-e-v-e-n-t/index.html +++ b/docs/appcues/com.appcues/-analytic-type/-e-v-e-n-t/index.html @@ -101,7 +101,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-analytic-type/-g-r-o-u-p/index.html b/docs/appcues/com.appcues/-analytic-type/-g-r-o-u-p/index.html index 7643b3f60..d2a221874 100644 --- a/docs/appcues/com.appcues/-analytic-type/-g-r-o-u-p/index.html +++ b/docs/appcues/com.appcues/-analytic-type/-g-r-o-u-p/index.html @@ -101,7 +101,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-analytic-type/-i-d-e-n-t-i-f-y/index.html b/docs/appcues/com.appcues/-analytic-type/-i-d-e-n-t-i-f-y/index.html index c3267ff4f..cca564e00 100644 --- a/docs/appcues/com.appcues/-analytic-type/-i-d-e-n-t-i-f-y/index.html +++ b/docs/appcues/com.appcues/-analytic-type/-i-d-e-n-t-i-f-y/index.html @@ -101,7 +101,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-analytic-type/-s-c-r-e-e-n/index.html b/docs/appcues/com.appcues/-analytic-type/-s-c-r-e-e-n/index.html index 5c494e6d3..32c9d89a6 100644 --- a/docs/appcues/com.appcues/-analytic-type/-s-c-r-e-e-n/index.html +++ b/docs/appcues/com.appcues/-analytic-type/-s-c-r-e-e-n/index.html @@ -101,7 +101,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-analytic-type/index.html b/docs/appcues/com.appcues/-analytic-type/index.html index da963e8c9..adc9ace32 100644 --- a/docs/appcues/com.appcues/-analytic-type/index.html +++ b/docs/appcues/com.appcues/-analytic-type/index.html @@ -199,7 +199,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-analytic-type/value-of.html b/docs/appcues/com.appcues/-analytic-type/value-of.html index 94214d82b..6e0aee589 100644 --- a/docs/appcues/com.appcues/-analytic-type/value-of.html +++ b/docs/appcues/com.appcues/-analytic-type/value-of.html @@ -62,7 +62,7 @@

valueOf

fun valueOf(value: String): AnalyticType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

if this enum type has no constant with the specified name

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-analytic-type/values.html b/docs/appcues/com.appcues/-analytic-type/values.html index 5daad3aa4..96f624634 100644 --- a/docs/appcues/com.appcues/-analytic-type/values.html +++ b/docs/appcues/com.appcues/-analytic-type/values.html @@ -62,7 +62,7 @@

values

fun values(): Array<AnalyticType>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-analytics-listener/index.html b/docs/appcues/com.appcues/-analytics-listener/index.html index 5397d036b..298f1a0bc 100644 --- a/docs/appcues/com.appcues/-analytics-listener/index.html +++ b/docs/appcues/com.appcues/-analytics-listener/index.html @@ -86,7 +86,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-analytics-listener/tracked-analytic.html b/docs/appcues/com.appcues/-analytics-listener/tracked-analytic.html index 01429816f..f966e4c97 100644 --- a/docs/appcues/com.appcues/-analytics-listener/tracked-analytic.html +++ b/docs/appcues/com.appcues/-analytics-listener/tracked-analytic.html @@ -62,7 +62,7 @@

trackedAnalytic
abstract fun trackedAnalytic(type: AnalyticType, value: String?, properties: Map<String, Any>?, isInternal: Boolean)

Notifies the listener when Appcues analytics tracking occurs.

Parameters

type

The type of the analytic.

value

Contains the primary value of the analytic being tracked. For events - the event name, for screens - the screen title, for identify - the userId, for group - the groupId

properties

Optional properties that provide additional context about the analytic.

isInternal

True, if the analytic was internally generated by the SDK, as opposed to passed in from the host application. For example, flow or session analytics are internal.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/activity-storage-max-age.html b/docs/appcues/com.appcues/-appcues-config/activity-storage-max-age.html index 51debaeb3..35dc11e6c 100644 --- a/docs/appcues/com.appcues/-appcues-config/activity-storage-max-age.html +++ b/docs/appcues/com.appcues/-appcues-config/activity-storage-max-age.html @@ -62,7 +62,7 @@

activityStorage
var activityStorageMaxAge: Int?

Sets the activity storage max age for the configuration, in seconds. This value determines how long an item can be stored on the local device and retried later, in the case of the device network connection being unavailable. Only requests that are more recent than the max age will be retried - or all, if not set.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/activity-storage-max-size.html b/docs/appcues/com.appcues/-appcues-config/activity-storage-max-size.html index 95565fd7a..4b775b5d2 100644 --- a/docs/appcues/com.appcues/-appcues-config/activity-storage-max-size.html +++ b/docs/appcues/com.appcues/-appcues-config/activity-storage-max-size.html @@ -62,7 +62,7 @@

activityStorage
var activityStorageMaxSize: Int

Set the activity storage max size for the configuration - maximum 25, minimum 0. This value determines how many analytics requests can be stored on the local device and retried later, in the case of the device network connection being unavailable. Only the most recent requests, up to this count, are retained.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/additional-auto-properties.html b/docs/appcues/com.appcues/-appcues-config/additional-auto-properties.html index 590ca5a54..fa6a109d4 100644 --- a/docs/appcues/com.appcues/-appcues-config/additional-auto-properties.html +++ b/docs/appcues/com.appcues/-appcues-config/additional-auto-properties.html @@ -62,7 +62,7 @@

additionalAuto
var additionalAutoProperties: Map<String, Any>

Define a set of additional properties that should be included in the auto properties sent on every analytics tracking call made by the SDK. The additional property names must be unique from those already captured in the SDK. If a property name conflicts with an existing auto property generated by the SDK, it is ignored.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/analytics-listener.html b/docs/appcues/com.appcues/-appcues-config/analytics-listener.html index a789a491b..f9fb92617 100644 --- a/docs/appcues/com.appcues/-appcues-config/analytics-listener.html +++ b/docs/appcues/com.appcues/-appcues-config/analytics-listener.html @@ -62,7 +62,7 @@

analyticsListener
var analyticsListener: AnalyticsListener?

Sets the listener to be notified about published analytics.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/anonymous-id-factory.html b/docs/appcues/com.appcues/-appcues-config/anonymous-id-factory.html index 7b9494494..2ce5197c2 100644 --- a/docs/appcues/com.appcues/-appcues-config/anonymous-id-factory.html +++ b/docs/appcues/com.appcues/-appcues-config/anonymous-id-factory.html @@ -62,7 +62,7 @@

anonymousId
var anonymousIdFactory: () -> String?

Set the factory responsible for generating anonymous user IDs.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/api-base-path.html b/docs/appcues/com.appcues/-appcues-config/api-base-path.html index 0cfe7c269..5376518f0 100644 --- a/docs/appcues/com.appcues/-appcues-config/api-base-path.html +++ b/docs/appcues/com.appcues/-appcues-config/api-base-path.html @@ -62,7 +62,7 @@

apiBase<
var apiBasePath: String?

Defines a custom api base path for the SDK. This path should consist of the scheme, host, and any additional path prefix required. If Not defined it will point to the default Appcues host: https://api.appcues.net/

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/experience-listener.html b/docs/appcues/com.appcues/-appcues-config/experience-listener.html index d034bb5e2..dd868c344 100644 --- a/docs/appcues/com.appcues/-appcues-config/experience-listener.html +++ b/docs/appcues/com.appcues/-appcues-config/experience-listener.html @@ -62,7 +62,7 @@

experienceListener<
var experienceListener: ExperienceListener?

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

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/index.html b/docs/appcues/com.appcues/-appcues-config/index.html index 71f1ba96b..0177e9619 100644 --- a/docs/appcues/com.appcues/-appcues-config/index.html +++ b/docs/appcues/com.appcues/-appcues-config/index.html @@ -236,7 +236,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/interceptor.html b/docs/appcues/com.appcues/-appcues-config/interceptor.html index 8e148278e..b22cf1fd8 100644 --- a/docs/appcues/com.appcues/-appcues-config/interceptor.html +++ b/docs/appcues/com.appcues/-appcues-config/interceptor.html @@ -62,7 +62,7 @@

interceptor

var interceptor: AppcuesInterceptor?

Set the interceptor for additional control over SDK runtime behaviors.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/logging-level.html b/docs/appcues/com.appcues/-appcues-config/logging-level.html index ae19695ce..8c1cf7e2c 100644 --- a/docs/appcues/com.appcues/-appcues-config/logging-level.html +++ b/docs/appcues/com.appcues/-appcues-config/logging-level.html @@ -62,7 +62,7 @@

loggingLevel
var loggingLevel: LoggingLevel

Set the logging level for the SDK.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/navigation-handler.html b/docs/appcues/com.appcues/-appcues-config/navigation-handler.html index f95e8c52e..9097bbb8a 100644 --- a/docs/appcues/com.appcues/-appcues-config/navigation-handler.html +++ b/docs/appcues/com.appcues/-appcues-config/navigation-handler.html @@ -62,7 +62,7 @@

navigationHandler
var navigationHandler: NavigationHandler?

Sets the handler to use for link navigation.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-config/session-timeout.html b/docs/appcues/com.appcues/-appcues-config/session-timeout.html index e76abf052..c252b8949 100644 --- a/docs/appcues/com.appcues/-appcues-config/session-timeout.html +++ b/docs/appcues/com.appcues/-appcues-config/session-timeout.html @@ -62,7 +62,7 @@

sessionTimeout
var sessionTimeout: Int

Set the session timeout for the configuration, in seconds. This timeout value is used to determine if a new session is started after a period of inactivity, or upon the application returning to the foreground. The default value is 300 seconds (5 minutes).

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-frame-view/-appcues-frame-view.html b/docs/appcues/com.appcues/-appcues-frame-view/-appcues-frame-view.html index cf0097d53..46d80223a 100644 --- a/docs/appcues/com.appcues/-appcues-frame-view/-appcues-frame-view.html +++ b/docs/appcues/com.appcues/-appcues-frame-view/-appcues-frame-view.html @@ -62,7 +62,7 @@

AppcuesFrame
@JvmOverloads
constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0)
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-frame-view/index.html b/docs/appcues/com.appcues/-appcues-frame-view/index.html index 346100eea..301023389 100644 --- a/docs/appcues/com.appcues/-appcues-frame-view/index.html +++ b/docs/appcues/com.appcues/-appcues-frame-view/index.html @@ -10200,7 +10200,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-frame.html b/docs/appcues/com.appcues/-appcues-frame.html index 4896ef7bc..800367e88 100644 --- a/docs/appcues/com.appcues/-appcues-frame.html +++ b/docs/appcues/com.appcues/-appcues-frame.html @@ -62,7 +62,7 @@

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

A Compose view that displays an Appcues experience.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-interceptor/can-display-experience.html b/docs/appcues/com.appcues/-appcues-interceptor/can-display-experience.html index 7954408b7..4e851efa2 100644 --- a/docs/appcues/com.appcues/-appcues-interceptor/can-display-experience.html +++ b/docs/appcues/com.appcues/-appcues-interceptor/can-display-experience.html @@ -62,7 +62,7 @@

canDisplay
abstract suspend fun canDisplayExperience(experienceId: UUID): Boolean

Determines if the given Appcues experience can display. Can be used to handle additional processing needed to get the application into a valid state to display before returning a value.

Return

true if the experience can be shown, false if not.

Parameters

experienceId

the ID of the experience that is being requested to display.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-interceptor/index.html b/docs/appcues/com.appcues/-appcues-interceptor/index.html index 175a6f58e..d5935cd3e 100644 --- a/docs/appcues/com.appcues/-appcues-interceptor/index.html +++ b/docs/appcues/com.appcues/-appcues-interceptor/index.html @@ -86,7 +86,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-provider-service/index.html b/docs/appcues/com.appcues/-appcues-provider-service/index.html index b0fad5c9e..ef1ed0852 100644 --- a/docs/appcues/com.appcues/-appcues-provider-service/index.html +++ b/docs/appcues/com.appcues/-appcues-provider-service/index.html @@ -101,7 +101,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-provider-service/start.html b/docs/appcues/com.appcues/-appcues-provider-service/start.html index 33fd8e114..dd86c90e0 100644 --- a/docs/appcues/com.appcues/-appcues-provider-service/start.html +++ b/docs/appcues/com.appcues/-appcues-provider-service/start.html @@ -62,7 +62,7 @@

start

fun start(context: Context)

Start Appcues services.

It is not normally expected to call this function, as services are started automatically using an androidx.startup.InitializationProvider. However, if necessary to have programmatic control to stop and start services, this function can be used.

The context parameter should be the currently active Activity, if possible, to ensure that the Appcues SDK has this Activity available to present content.

Parameters

context

The Android Context used by the host application.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues-provider-service/stop.html b/docs/appcues/com.appcues/-appcues-provider-service/stop.html index 058a13a95..f84869acb 100644 --- a/docs/appcues/com.appcues/-appcues-provider-service/stop.html +++ b/docs/appcues/com.appcues/-appcues-provider-service/stop.html @@ -62,7 +62,7 @@

stop

fun stop(context: Context)

Stop Appcues services.

It is not normally expected to call this function, as services are started automatically using an androidx.startup.InitializationProvider. However, if necessary to have programmatic control to stop and start services, this function can be used.

Parameters

context

The Android Context used by the host application.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues.html b/docs/appcues/com.appcues/-appcues.html index 9b4b99985..63e95f0fa 100644 --- a/docs/appcues/com.appcues/-appcues.html +++ b/docs/appcues/com.appcues/-appcues.html @@ -62,7 +62,7 @@

Appcues

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

Construct and return an instance of the Appcues SDK.

Parameters

context

The Android Context used by the host application.

accountId

The Appcues Account ID found in Studio settings.

applicationId

The Appcues Application ID found in Studio settings.

config

Optional, additional settings on AppcuesConfig to use when initializing the SDK.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/-companion/element-targeting.html b/docs/appcues/com.appcues/-appcues/-companion/element-targeting.html index 84c16e237..6ef316d91 100644 --- a/docs/appcues/com.appcues/-appcues/-companion/element-targeting.html +++ b/docs/appcues/com.appcues/-appcues/-companion/element-targeting.html @@ -62,7 +62,7 @@

elementTargeting
var elementTargeting: ElementTargetingStrategy

Defines an element targeting strategy to use to capture application UI elements and use in target element experiences, such as anchored tooltips. The default implementation provided by the SDK is based on Android View layout information.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/-companion/index.html b/docs/appcues/com.appcues/-appcues/-companion/index.html index 15d78a23b..98a0a2944 100644 --- a/docs/appcues/com.appcues/-appcues/-companion/index.html +++ b/docs/appcues/com.appcues/-appcues/-companion/index.html @@ -101,7 +101,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/-companion/version.html b/docs/appcues/com.appcues/-appcues/-companion/version.html index 51a5b8178..bf5a5c7b2 100644 --- a/docs/appcues/com.appcues/-appcues/-companion/version.html +++ b/docs/appcues/com.appcues/-appcues/-companion/version.html @@ -62,7 +62,7 @@

version

val version: String

The current version of Appcues SDK.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/analytics-listener.html b/docs/appcues/com.appcues/-appcues/analytics-listener.html index 6c2c43ccc..0c3c2a6a3 100644 --- a/docs/appcues/com.appcues/-appcues/analytics-listener.html +++ b/docs/appcues/com.appcues/-appcues/analytics-listener.html @@ -62,7 +62,7 @@

analyticsListener
var analyticsListener: AnalyticsListener?

Sets the listener to be notified about published analytics.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/anonymous.html b/docs/appcues/com.appcues/-appcues/anonymous.html index 03cc48dfb..2eeb3fa26 100644 --- a/docs/appcues/com.appcues/-appcues/anonymous.html +++ b/docs/appcues/com.appcues/-appcues/anonymous.html @@ -62,7 +62,7 @@

anonymous

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 anonymous(properties: Map<String, Any>?)

Deprecated (with error)

properties are no longer supported for anonymous users.

This function has been removed. Calling the anonymous function with a properties parameter is no longer supported. A call to anonymous() with no parameters should be used instead.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/debug.html b/docs/appcues/com.appcues/-appcues/debug.html index 82e0b00a7..9e7616fbc 100644 --- a/docs/appcues/com.appcues/-appcues/debug.html +++ b/docs/appcues/com.appcues/-appcues/debug.html @@ -62,7 +62,7 @@

debug

fun debug(activity: Activity)

Starts the Appcues Debugger over the specified Activity.

Parameters

activity

The Activity to launch the debugger over.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/experience-listener.html b/docs/appcues/com.appcues/-appcues/experience-listener.html index 7d8b814cc..9c2094750 100644 --- a/docs/appcues/com.appcues/-appcues/experience-listener.html +++ b/docs/appcues/com.appcues/-appcues/experience-listener.html @@ -62,7 +62,7 @@

experienceListener<
var experienceListener: ExperienceListener?

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

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/group.html b/docs/appcues/com.appcues/-appcues/group.html index 9f87d84f9..d6d65efd6 100644 --- a/docs/appcues/com.appcues/-appcues/group.html +++ b/docs/appcues/com.appcues/-appcues/group.html @@ -62,7 +62,7 @@

group

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

Identify a group for the current user.

Parameters

groupId

Unique value identifying the group.

properties

Optional properties that provide additional context about the group.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/identify.html b/docs/appcues/com.appcues/-appcues/identify.html index f789a9499..000cff901 100644 --- a/docs/appcues/com.appcues/-appcues/identify.html +++ b/docs/appcues/com.appcues/-appcues/identify.html @@ -62,7 +62,7 @@

identify

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

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

To authenticate requests for this user, provide the Base64 encoded signature for this user as a String value for key "appcues:user_id_signature", in the properties provided.

Parameters

userId

Unique value identifying the user.

properties

Optional properties that provide additional context about the user.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/index.html b/docs/appcues/com.appcues/-appcues/index.html index b6d0300eb..0b4e88279 100644 --- a/docs/appcues/com.appcues/-appcues/index.html +++ b/docs/appcues/com.appcues/-appcues/index.html @@ -349,7 +349,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/interceptor.html b/docs/appcues/com.appcues/-appcues/interceptor.html index 7ae236f2c..85d339d26 100644 --- a/docs/appcues/com.appcues/-appcues/interceptor.html +++ b/docs/appcues/com.appcues/-appcues/interceptor.html @@ -62,7 +62,7 @@

interceptor

var interceptor: AppcuesInterceptor?

Set the interceptor for additional control over SDK runtime behaviors.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/navigation-handler.html b/docs/appcues/com.appcues/-appcues/navigation-handler.html index b9b928bf0..a1e2bc716 100644 --- a/docs/appcues/com.appcues/-appcues/navigation-handler.html +++ b/docs/appcues/com.appcues/-appcues/navigation-handler.html @@ -62,7 +62,7 @@

navigationHandler
var navigationHandler: NavigationHandler?

Sets the handler to use for link navigation.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/on-new-intent.html b/docs/appcues/com.appcues/-appcues/on-new-intent.html index 52aeca72c..9fc9c4c70 100644 --- a/docs/appcues/com.appcues/-appcues/on-new-intent.html +++ b/docs/appcues/com.appcues/-appcues/on-new-intent.html @@ -62,7 +62,7 @@

onNew
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.

Return

True if a deep link was handled by the Appcues SDK, false if not - meaning the host application should process.

Parameters

activity

Current activity handling the intent

intent

Intent that the Appcues SDK should check for deep link content.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/register-embed.html b/docs/appcues/com.appcues/-appcues/register-embed.html index da0d43b0b..d965e8742 100644 --- a/docs/appcues/com.appcues/-appcues/register-embed.html +++ b/docs/appcues/com.appcues/-appcues/register-embed.html @@ -62,7 +62,7 @@

registerEmbed
fun registerEmbed(frameId: String, frame: AppcuesFrameView)

Register an AppcuesFrameView for a given frameId.

Parameters

frameId

unique string set in builder that is used to identify this AppcuesFrameView with qualified experiences

frame

frame used to inflate the embedded experience

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/reset.html b/docs/appcues/com.appcues/-appcues/reset.html index 48faec52a..d7a74741c 100644 --- a/docs/appcues/com.appcues/-appcues/reset.html +++ b/docs/appcues/com.appcues/-appcues/reset.html @@ -62,7 +62,7 @@

reset

fun reset()

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

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/screen.html b/docs/appcues/com.appcues/-appcues/screen.html index 1fb4715c1..7e0b78bcb 100644 --- a/docs/appcues/com.appcues/-appcues/screen.html +++ b/docs/appcues/com.appcues/-appcues/screen.html @@ -62,7 +62,7 @@

screen

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

Track an screen viewed by a user.

Parameters

title

Name of the screen

properties

Optional properties that provide additional context about the screen.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/show.html b/docs/appcues/com.appcues/-appcues/show.html index 02ec89e18..812b1259f 100644 --- a/docs/appcues/com.appcues/-appcues/show.html +++ b/docs/appcues/com.appcues/-appcues/show.html @@ -62,7 +62,7 @@

show

suspend fun show(experienceId: String): Boolean

Renders the specified Appcues experience for the current user.

Return

True if experience content was able to be shown, false if not.

Parameters

experienceId

ID of the experience.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/stop.html b/docs/appcues/com.appcues/-appcues/stop.html index e8dde0a23..84321c7eb 100644 --- a/docs/appcues/com.appcues/-appcues/stop.html +++ b/docs/appcues/com.appcues/-appcues/stop.html @@ -62,7 +62,7 @@

stop

fun stop()

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

This method is only expected to be called if you are intending to fully remove an Appcues SDK instance and create a new one. This is not normally an expected behavior for most use cases of the SDK.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/track-screens.html b/docs/appcues/com.appcues/-appcues/track-screens.html index 7e89deb3d..dae9340b4 100644 --- a/docs/appcues/com.appcues/-appcues/track-screens.html +++ b/docs/appcues/com.appcues/-appcues/track-screens.html @@ -62,7 +62,7 @@

trackScreens
fun trackScreens()

Enables automatic screen tracking for Activities.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/track.html b/docs/appcues/com.appcues/-appcues/track.html index 2bd2cddb6..749dec5a5 100644 --- a/docs/appcues/com.appcues/-appcues/track.html +++ b/docs/appcues/com.appcues/-appcues/track.html @@ -62,7 +62,7 @@

track

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

Track an action taken by a user.

Parameters

name

Name of the event.

properties

Optional properties that provide additional context about the event.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-appcues/version.html b/docs/appcues/com.appcues/-appcues/version.html index de1124360..b0a93b135 100644 --- a/docs/appcues/com.appcues/-appcues/version.html +++ b/docs/appcues/com.appcues/-appcues/version.html @@ -62,7 +62,7 @@

version

val version: String

The current version of Appcues SDK.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-element-selector/evaluate-match.html b/docs/appcues/com.appcues/-element-selector/evaluate-match.html index ed7c3e016..d1544b0ed 100644 --- a/docs/appcues/com.appcues/-element-selector/evaluate-match.html +++ b/docs/appcues/com.appcues/-element-selector/evaluate-match.html @@ -62,7 +62,7 @@

evaluateMatch
abstract fun evaluateMatch(target: ElementSelector): Int

Evaluate how closely this selector matches with the given target selector.

Any value greater than zero means there is a match. The higher the value, the more exact the match. In the cases of selectors with multiple identifying attributes, there may be partial matches with lower values, and exact matches with higher values. Any negative value indicates no match.

Return

Value for the quality of selector match.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-element-selector/index.html b/docs/appcues/com.appcues/-element-selector/index.html index b2b1f0197..02651e7af 100644 --- a/docs/appcues/com.appcues/-element-selector/index.html +++ b/docs/appcues/com.appcues/-element-selector/index.html @@ -101,7 +101,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-element-selector/to-map.html b/docs/appcues/com.appcues/-element-selector/to-map.html index cea2e9388..01ec5b146 100644 --- a/docs/appcues/com.appcues/-element-selector/to-map.html +++ b/docs/appcues/com.appcues/-element-selector/to-map.html @@ -62,7 +62,7 @@

toMap

abstract fun toMap(): Map<String, String>

Exports the selector properties into a string mapping for serialization.

Return

Map of string key-value pairs for selector properties.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-element-targeting-strategy/capture-layout.html b/docs/appcues/com.appcues/-element-targeting-strategy/capture-layout.html index 1ea64ae97..7b46d830d 100644 --- a/docs/appcues/com.appcues/-element-targeting-strategy/capture-layout.html +++ b/docs/appcues/com.appcues/-element-targeting-strategy/capture-layout.html @@ -62,7 +62,7 @@

captureLayout
abstract fun captureLayout(): ViewElement?

Capture the layout hierarchy in the currently rendered screen of the application.

Return

: Root view element for the current screen, or null if not available. The view element contains sub-views recursively in the children property.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-element-targeting-strategy/capture-screenshot.html b/docs/appcues/com.appcues/-element-targeting-strategy/capture-screenshot.html index 0b89d224e..7d3b911ee 100644 --- a/docs/appcues/com.appcues/-element-targeting-strategy/capture-screenshot.html +++ b/docs/appcues/com.appcues/-element-targeting-strategy/capture-screenshot.html @@ -62,7 +62,7 @@

captureScreenshot
open fun captureScreenshot(): Screenshot?

Capture the screenshot image for the currently rendered screen of the application.

This is an optional override to support specialized screen capture from plugins, if needed. However, normally the default screenshot capturing the root view of the application will suffice, in which case this function can be omitted.

Return

: The screenshot data for the current screen, or null if not available. If null, the default screenshot of the current root view of the application will be used.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-element-targeting-strategy/index.html b/docs/appcues/com.appcues/-element-targeting-strategy/index.html index b38a9680d..663ebf738 100644 --- a/docs/appcues/com.appcues/-element-targeting-strategy/index.html +++ b/docs/appcues/com.appcues/-element-targeting-strategy/index.html @@ -116,7 +116,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-element-targeting-strategy/inflate-selector-from.html b/docs/appcues/com.appcues/-element-targeting-strategy/inflate-selector-from.html index 06f8ea9f9..d28ffa43c 100644 --- a/docs/appcues/com.appcues/-element-targeting-strategy/inflate-selector-from.html +++ b/docs/appcues/com.appcues/-element-targeting-strategy/inflate-selector-from.html @@ -62,7 +62,7 @@

inflateSelector
abstract fun inflateSelectorFrom(properties: Map<String, String>): ElementSelector?

Create and return a selector implementation from configuration properties.

Return

the ElementSelector implementation for this element targeting strategy, based on the given properties. If no applicable properties are found, the return value should be nil.

Parameters

properties

Key-value collection of properties to identify a given view element.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-experience-listener/experience-finished.html b/docs/appcues/com.appcues/-experience-listener/experience-finished.html index e314c507a..f6d8a8100 100644 --- a/docs/appcues/com.appcues/-experience-listener/experience-finished.html +++ b/docs/appcues/com.appcues/-experience-listener/experience-finished.html @@ -62,7 +62,7 @@

experienceFinished<
abstract fun experienceFinished(experienceId: UUID)

Notifies the listener when an Experience has finished.

Parameters

experienceId

The ID of the Experience that has finished.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-experience-listener/experience-started.html b/docs/appcues/com.appcues/-experience-listener/experience-started.html index 388396166..ad694d29b 100644 --- a/docs/appcues/com.appcues/-experience-listener/experience-started.html +++ b/docs/appcues/com.appcues/-experience-listener/experience-started.html @@ -62,7 +62,7 @@

experienceStarted
abstract fun experienceStarted(experienceId: UUID)

Notifies the listener when an Experience is starting.

Parameters

experienceId

The ID of the Experience that is starting.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-experience-listener/index.html b/docs/appcues/com.appcues/-experience-listener/index.html index 33b34bff9..8cb88d3cb 100644 --- a/docs/appcues/com.appcues/-experience-listener/index.html +++ b/docs/appcues/com.appcues/-experience-listener/index.html @@ -101,7 +101,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-logging-level/-d-e-b-u-g/index.html b/docs/appcues/com.appcues/-logging-level/-d-e-b-u-g/index.html index 84da7bae0..284a42ad8 100644 --- a/docs/appcues/com.appcues/-logging-level/-d-e-b-u-g/index.html +++ b/docs/appcues/com.appcues/-logging-level/-d-e-b-u-g/index.html @@ -101,7 +101,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-logging-level/-i-n-f-o/index.html b/docs/appcues/com.appcues/-logging-level/-i-n-f-o/index.html index 944c4a5b4..3fc1fc2c7 100644 --- a/docs/appcues/com.appcues/-logging-level/-i-n-f-o/index.html +++ b/docs/appcues/com.appcues/-logging-level/-i-n-f-o/index.html @@ -101,7 +101,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-logging-level/-n-o-n-e/index.html b/docs/appcues/com.appcues/-logging-level/-n-o-n-e/index.html index 6508f6f16..40afdf122 100644 --- a/docs/appcues/com.appcues/-logging-level/-n-o-n-e/index.html +++ b/docs/appcues/com.appcues/-logging-level/-n-o-n-e/index.html @@ -101,7 +101,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-logging-level/index.html b/docs/appcues/com.appcues/-logging-level/index.html index 17c3a1eaa..2c2aef920 100644 --- a/docs/appcues/com.appcues/-logging-level/index.html +++ b/docs/appcues/com.appcues/-logging-level/index.html @@ -184,7 +184,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-logging-level/value-of.html b/docs/appcues/com.appcues/-logging-level/value-of.html index aba557c72..45f580e14 100644 --- a/docs/appcues/com.appcues/-logging-level/value-of.html +++ b/docs/appcues/com.appcues/-logging-level/value-of.html @@ -62,7 +62,7 @@

valueOf

fun valueOf(value: String): LoggingLevel

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws

if this enum type has no constant with the specified name

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-logging-level/values.html b/docs/appcues/com.appcues/-logging-level/values.html index d6d9a02c1..861671982 100644 --- a/docs/appcues/com.appcues/-logging-level/values.html +++ b/docs/appcues/com.appcues/-logging-level/values.html @@ -62,7 +62,7 @@

values

fun values(): Array<LoggingLevel>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-navigation-handler/index.html b/docs/appcues/com.appcues/-navigation-handler/index.html index 2b886b838..63af049f3 100644 --- a/docs/appcues/com.appcues/-navigation-handler/index.html +++ b/docs/appcues/com.appcues/-navigation-handler/index.html @@ -86,7 +86,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-navigation-handler/navigate-to.html b/docs/appcues/com.appcues/-navigation-handler/navigate-to.html index 1cb55d2aa..3d29e3253 100644 --- a/docs/appcues/com.appcues/-navigation-handler/navigate-to.html +++ b/docs/appcues/com.appcues/-navigation-handler/navigate-to.html @@ -62,7 +62,7 @@

navigateTo
abstract suspend fun navigateTo(uri: Uri): Boolean

Navigates to the given uri, suspending until navigation has completed. The navigation path value in uri may be a scheme link (deep link) inside of the current application, or an external web or application link.

Return

true if the navigation completed successfully, false if not.

Parameters

uri

the uri for the destination to navigate.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-screenshot/-screenshot.html b/docs/appcues/com.appcues/-screenshot/-screenshot.html index b134e6ffe..85b2a40b1 100644 --- a/docs/appcues/com.appcues/-screenshot/-screenshot.html +++ b/docs/appcues/com.appcues/-screenshot/-screenshot.html @@ -62,7 +62,7 @@

Screenshot

constructor(bitmap: Bitmap, size: Size, insets: Insets)
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-screenshot/bitmap.html b/docs/appcues/com.appcues/-screenshot/bitmap.html index 5ca5dc82c..56bec86d1 100644 --- a/docs/appcues/com.appcues/-screenshot/bitmap.html +++ b/docs/appcues/com.appcues/-screenshot/bitmap.html @@ -62,7 +62,7 @@

bitmap

val bitmap: Bitmap

The image data for the screenshot.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-screenshot/index.html b/docs/appcues/com.appcues/-screenshot/index.html index f7bccd24a..cdd89eabd 100644 --- a/docs/appcues/com.appcues/-screenshot/index.html +++ b/docs/appcues/com.appcues/-screenshot/index.html @@ -135,7 +135,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-screenshot/insets.html b/docs/appcues/com.appcues/-screenshot/insets.html index eceb5336e..37d527972 100644 --- a/docs/appcues/com.appcues/-screenshot/insets.html +++ b/docs/appcues/com.appcues/-screenshot/insets.html @@ -62,7 +62,7 @@

insets

val insets: Insets

The insets in Dp to apply for any visible system bars, used to define the area eligible for targeting content.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-screenshot/size.html b/docs/appcues/com.appcues/-screenshot/size.html index 85693f356..dfcc14b3a 100644 --- a/docs/appcues/com.appcues/-screenshot/size.html +++ b/docs/appcues/com.appcues/-screenshot/size.html @@ -62,7 +62,7 @@

size

val size: Size

The size of the screenshot image in Dp, including any visible system bars.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/-view-element.html b/docs/appcues/com.appcues/-view-element/-view-element.html index e4b77e0f0..ae2bf8d95 100644 --- a/docs/appcues/com.appcues/-view-element/-view-element.html +++ b/docs/appcues/com.appcues/-view-element/-view-element.html @@ -62,7 +62,7 @@

ViewElement<
constructor(id: UUID = UUID.randomUUID(), x: Int, y: Int, width: Int, height: Int, type: String, displayName: String?, selector: ElementSelector?, children: List<ViewElement>?)
- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/children.html b/docs/appcues/com.appcues/-view-element/children.html index 2dc9e8996..55a7485d7 100644 --- a/docs/appcues/com.appcues/-view-element/children.html +++ b/docs/appcues/com.appcues/-view-element/children.html @@ -62,7 +62,7 @@

children

val children: List<ViewElement>?

The sub-views contained within this view, if any.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/display-name.html b/docs/appcues/com.appcues/-view-element/display-name.html index 000182e0c..b86302815 100644 --- a/docs/appcues/com.appcues/-view-element/display-name.html +++ b/docs/appcues/com.appcues/-view-element/display-name.html @@ -62,7 +62,7 @@

displayName<
val displayName: String?

A value representing the display name of the view.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/height.html b/docs/appcues/com.appcues/-view-element/height.html index 999c75a5c..3ab86bc66 100644 --- a/docs/appcues/com.appcues/-view-element/height.html +++ b/docs/appcues/com.appcues/-view-element/height.html @@ -62,7 +62,7 @@

height

val height: Int

The height of the view.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/id.html b/docs/appcues/com.appcues/-view-element/id.html index e530ada8f..3cfa4c396 100644 --- a/docs/appcues/com.appcues/-view-element/id.html +++ b/docs/appcues/com.appcues/-view-element/id.html @@ -62,7 +62,7 @@

id

val id: UUID

Auto-generated unique ID for the view.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/index.html b/docs/appcues/com.appcues/-view-element/index.html index b16fc90c7..49abda35e 100644 --- a/docs/appcues/com.appcues/-view-element/index.html +++ b/docs/appcues/com.appcues/-view-element/index.html @@ -225,7 +225,7 @@

Properties

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/selector.html b/docs/appcues/com.appcues/-view-element/selector.html index 5bfa27420..75958703d 100644 --- a/docs/appcues/com.appcues/-view-element/selector.html +++ b/docs/appcues/com.appcues/-view-element/selector.html @@ -62,7 +62,7 @@

selector

val selector: ElementSelector?

The element selector details that can be used to target content to this view. The selector structure depends on the UI toolkit in use. If no identifiable properties exist for this view, this selector value should be null.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/type.html b/docs/appcues/com.appcues/-view-element/type.html index 09ee1da3b..edb00afe6 100644 --- a/docs/appcues/com.appcues/-view-element/type.html +++ b/docs/appcues/com.appcues/-view-element/type.html @@ -62,7 +62,7 @@

type

val type: String

A value representing the type of the view.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/width.html b/docs/appcues/com.appcues/-view-element/width.html index fed037003..04b047b47 100644 --- a/docs/appcues/com.appcues/-view-element/width.html +++ b/docs/appcues/com.appcues/-view-element/width.html @@ -62,7 +62,7 @@

width

val width: Int

The width of the view.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/x.html b/docs/appcues/com.appcues/-view-element/x.html index 4e30b855a..0a0c1a881 100644 --- a/docs/appcues/com.appcues/-view-element/x.html +++ b/docs/appcues/com.appcues/-view-element/x.html @@ -62,7 +62,7 @@

x

val x: Int

The x-coordinate for view position, with origin in the upper-left corner. This value is in screen coordinates, not relative to the parent.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/-view-element/y.html b/docs/appcues/com.appcues/-view-element/y.html index 57cb6ea9c..09a209c23 100644 --- a/docs/appcues/com.appcues/-view-element/y.html +++ b/docs/appcues/com.appcues/-view-element/y.html @@ -62,7 +62,7 @@

y

val y: Int

The y-coordinate for view position, with origin is in the upper-left corner. This value is in screen coordinates, not relative to the parent.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/appcues-view.html b/docs/appcues/com.appcues/appcues-view.html index 70583ce86..0e2e0b82f 100644 --- a/docs/appcues/com.appcues/appcues-view.html +++ b/docs/appcues/com.appcues/appcues-view.html @@ -62,7 +62,7 @@

appcuesView<
@Stable
fun Modifier.appcuesView(tag: String): Modifier

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

Parameters

tag

the view tag, which should uniquely identify this element within the full Composition being rendered.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/index.html b/docs/appcues/com.appcues/index.html index 5795e675e..46ea515d1 100644 --- a/docs/appcues/com.appcues/index.html +++ b/docs/appcues/com.appcues/index.html @@ -344,7 +344,7 @@

Functions

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/appcues/com.appcues/is-appcues-view.html b/docs/appcues/com.appcues/is-appcues-view.html index adba8cea1..29cdc1037 100644 --- a/docs/appcues/com.appcues/is-appcues-view.html +++ b/docs/appcues/com.appcues/is-appcues-view.html @@ -62,7 +62,7 @@

isAppcues
fun View.isAppcuesView(): Boolean

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

Return

True if this view was created by the Appcues SDK.

- © 2023 Copyright© 2024 CopyrightGenerated by dokka
diff --git a/docs/index.html b/docs/index.html index eb3eb6517..610b4525d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -81,7 +81,7 @@

Packages

- © 2023 Copyright© 2024 CopyrightGenerated by dokka