fl-analytics/com.quickplay.vstb7.analytics.session.user/UserSession

UserSession

class UserSession : AnalyticsSession<Unit, Error> , AnalyticsSessionErrorEventPublisher<UserError, User> , UserAction

Represents AnalyticsSession instance to report user's actions events and metadata. Note that ApplicationSession factory method ApplicationSession.createUserSession must be used for session instance creation.

Properties

configs

open override var configs: List<AnalyticsReporter.Configuration>

The AnalyticsReporter.Configuration instance.

isAnalyticsSystemConnected

open override var isAnalyticsSystemConnected: Boolean

The connectivity status to the analytics system.

logger

open override var logger: Logger

The Logger for call tracing.

state

open override var state: AnalyticsSession.State

The current lifecycle State.

Functions

addErrorEvent

open override fun addErrorEvent(error: UserError, value: User?)

Adds custom error event to be published by the analytics reporting system.

changeSubscription

open override fun changeSubscription(user: User)

Called when User executes "change subscription" flow.

completePayment

open override fun completePayment(user: User)

Called when User executes "complete payment" flow.

createProfile

open override fun createProfile(user: User)

Called when User executes "create profile" flow.

deleteProfile

open override fun deleteProfile(user: User)

Called when User executes "delete profile" flow.

forgotPassword

open override fun forgotPassword(user: User)

Called when User executes "forgot password" flow.

open override fun login(user: User)

Called when User executes "login" flow.

logout

open override fun logout(user: User)

Called when User executes "logout" flow.

purchaseSubscription

open override fun purchaseSubscription(user: User)

Called when User executes "purchase subscription" flow.

purchaseSubscriptionCancel

open override fun purchaseSubscriptionCancel(user: User)

Called when User executes "purchase subscription cancel" flow.

purchaseSubscriptionFailure

open override fun purchaseSubscriptionFailure(user: User)

Called when User executes "purchase subscription failure" flow.

signup

open override fun signup(user: User)

Called when User executes "signup" flow.

start

open override fun start(value: Unit)

Must be called to initiate analytics session lifecycle.

startSubscription

open override fun startSubscription(user: User)

Called when User executes "start subscription" flow.

stop

open override fun stop(error: Error?)

Must be called to terminate analytics session lifecycle.

updateMetadata

open override fun updateMetadata(user: User)

Called when "update metadata" is required. It updates existing user metadata records only without sending any event.

updateProfile

open override fun updateProfile(user: User)

Called when User executes "update profile" flow.