PeriodicActionStreak

data class PeriodicActionStreak(val id: String, val name: String, val description: String, val status: StreakStatus, val action: LoyaltyAction, val startTime: Calendar, val expirationTime: Calendar?, val threshold: Int, val period: StreakPeriod, val progress: PeriodicActionStreakProgress?) : Streak

A streak where customers must perform an action within a recurring time window (daily, weekly, monthly).

Parameters

id

Unique identifier of the streak.

name

Display name of the streak.

description

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

status

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

action

The qualifying action that advances the streak.

startTime

When the streak becomes available to customers.

expirationTime

The date and time when the streak campaign expires.

threshold

How many times the associated action must be completed within a given period to advance the streak length.

period

The window within which the customer must perform the action.

progress

The customer's progress within the streak.

Constructors

Link copied to clipboard
constructor(id: String, name: String, description: String, status: StreakStatus, action: LoyaltyAction, startTime: Calendar, expirationTime: Calendar?, threshold: Int, period: StreakPeriod, progress: PeriodicActionStreakProgress?)

Properties

Link copied to clipboard
open override val action: LoyaltyAction
Link copied to clipboard
open override val description: String
Link copied to clipboard
open override val expirationTime: Calendar?
Link copied to clipboard
open override val id: String
Link copied to clipboard
open override val name: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val startTime: Calendar
Link copied to clipboard
open override val status: StreakStatus
Link copied to clipboard
Link copied to clipboard
open override val type: StreakType

Determines how progress is accumulated and when the streak resets.