Android SDK reference

Every public class of the Personyze Android SDK 2.1, in the package com.personyze.android (the composable is in com.personyze.android.compose). How to put them together is in the Android SDK guide.

None of these throw for a network or server problem. A failed call answers an empty result with its error set, and every failure reaches the error listener. Only programming errors throw, such as an empty API key or a baseUrl that is not https://.

Personyze

The entry point: an object that forwards every call to the client created by initialize.

Called before initialize, the events and reports are ignored (and logged), and the suspend calls answer an empty result.

Events

Each call queues one event and returns at once; all are safe to call from any thread. The queue goes out with the next navigate, or by itself 3 seconds after the last event, or when the app goes to the background. Product and article ids are the Internal ID in your catalog. actionId attributes the event to the action that showed the item: with it, a purchase counts for the Products purchased criterion of that action's A/B test.

A blank id, or a promotion without its action id, is not sent: the call is ignored and the error listener gets a PersonyzeException.Invalid.

PersonyzeConfig

The settings, built with a block:

PersonyzeConfig("YOUR_API_KEY") {
    notifications = true
    timeout = 3.seconds
}

PersonyzeResult

What Personyze decided for the visitor: the campaigns they match and the actions to present. navigate replaces it; events and reports sent without a navigation add to it, and remove what Personyze withdrew.

PersonyzeAction

An action Personyze decided to present: usually HTML (a banner, a recommendation widget), sometimes JSON or text that you render yourself. The decision and the action's per-visitor data arrive first; the template arrives a moment later and is cached.

PersonyzeCondition

A campaign the visitor matches: id: Int, and name: String?, its name in the panel.

PersonyzePlaceholder

A placeholder an action is targeted to. In an app, a named slot of your own.

PersonyzeActionView

A View (a FrameLayout) that renders an HTML action in a WebView and reports what happens in it. It can be created in code or in a layout.

A tap that the click listener does not handle does the default: a link opens in the browser, and a close hides the view.

PersonyzeActionContent

The Compose version of PersonyzeActionView, in personyze-android-compose:

@Composable
fun PersonyzeActionContent(
    action: PersonyzeAction,
    modifier: Modifier = Modifier,
    reportExecuted: Boolean = true,
    reportClicks: Boolean = true,
    onClick: ((PersonyzeClick) -> Boolean)? = null
)

It takes the content's height unless modifier sets one, and releases its WebView when it leaves the composition. onClick returns true when the app handled the tap.

PersonyzeClick

A tap inside a rendered action.

PersonyzeClickListener is the handler: fun onClick(click: PersonyzeClick): Boolean, returning true when the app handled the tap.

PersonyzeVisitor

Who Personyze is talking about right now, from Personyze.visitor.

PersonyzeNotification

A notification the SDK showed, as checkNotifications() answers it: messageId, title, body, url (where a tap goes), imageUrl, iconUrl, badgeUrl, buttons (each with title, iconUrl and url), silent, renotify, and vibrate (a pattern in milliseconds).

PersonyzePushStatus

Where push stands on this install, from Personyze.pushStatus: what a screen of your app, or a support case, can show when notifications do not arrive at once. Its toString() cuts the token short.

PersonyzeVerdict

Who is winning an A/B test, as verdict(conditionId) answers it. The same comparison the panel shows; see ab_test for what each value means.

PersonyzeException

What the error listener receives, and what PersonyzeResult.error holds. The SDK never throws these at your code. No message ever contains the API key.

PersonyzeErrorListener

Receives every failure the SDK absorbs, on a background thread:

fun interface PersonyzeErrorListener
{   fun onError(error: PersonyzeException, context: PersonyzeErrorContext)
}

PersonyzeErrorContext says where it happened: operation (navigate, refresh, flush, metadata, notifications, verdict or track), and how many events were deferred (kept to send later) or dropped.