core/com.paysafe.wallet.android.core.loyalty.model/Streak

Streak

sealed interface Streak

A streak tracks a user's progress as they repeat a defined action consistently over time. It continues as long as the rules are met, and resets if interrupted.

Inheritors

ConsecutiveActionStreak

PeriodicActionStreak

Properties

action

abstract val action: LoyaltyAction

The customer action required to make progress in the streak.

description

abstract val description: String

Describes the purpose, rules, or goal of the streak.

expirationTime

abstract val expirationTime: Calendar?

The date and time when the streak campaign expires.

abstract val id: String

Unique identifier of the streak.

name

abstract val name: String

Display name of the streak.

startTime

abstract val startTime: Calendar

When the streak becomes available to customers.

status

abstract val status: StreakStatus

Current state of the customer's participation in the streak.

type

abstract val type: StreakType

Determines how progress is accumulated and when the streak resets.