PushPushGo SDK/com.pushpushgo.sdk.push.liveactivity.data

Package-level declarations

Types

data class FootballMatchAndroidDesign(val hasTrackerIcon: Boolean, val progressBarColor: LiveActivityColorSet?, val breakTimeBarColor: LiveActivityColorSet?)

Android-specific design block of the football match template. Mirrors the backend / iOS design.android object. All fields are optional so the SDK falls back to built-in defaults when the backend omits them.

FootballMatchConfiguration

data class FootballMatchConfiguration(val template: LiveActivityTemplate, val content: FootballMatchContent, val design: FootballMatchAndroidDesign?, val statusLabels: Map<String, String>, val actions: List<LiveActivityAction>, val timeoutMinutes: Int?, val url: String?)

Static configuration of a football match Live Activity, delivered in the configuration field of the start push. Mirrors the backend / iOS football match configuration DTO.

FootballMatchContent

data class FootballMatchContent(val title: String, val homeTeamName: String, val homeTeamImage: String?, val awayTeamName: String, val awayTeamImage: String?)

Static content of the football match template. Field-for-field mirror of the backend / iOS content block. Empty image strings from the backend are kept as-is here and normalized to null at render time.

FootballMatchLiveData

data class FootballMatchLiveData(val homeTeamScore: Int, val awayTeamScore: Int, val status: MatchPhase, val statusChangedAt: Long?, val liveDataVersion: Int = 0)

Dynamic, real-time state of a football match Live Activity, delivered in the liveData field of start / update pushes. Mirrors the backend / iOS football match live data DTO.

HotMessage

data class HotMessage(val id: String, val text: String, val expiresAtMs: Long?)

Transient, time-bounded message shown on top of a Live Activity (e.g. "Goal cancelled after VAR"). Mirrors the backend / iOS hotMessage ({ id, text, timestamp }, where timestamp is the Unix-epoch-seconds hard expiry). Visibility is the minimum of a local display cap and the backend expiry — matching the iOS behavior.

LiveActivity

data class LiveActivity(val id: String, val projectId: String, val subscriberId: String, val template: LiveActivityTemplate, val status: LiveActivityStatus, val configuration: FootballMatchConfiguration, val liveData: FootballMatchLiveData, val hotMessage: HotMessage?, val createdAt: Long = System.currentTimeMillis(), val updatedAt: Long = System.currentTimeMillis(), val countdownMessage: String? = null, val countdownEndAtMs: Long? = null)

In-memory representation of a tracked Live Activity. Combines the static configuration (received once with the start event) and the latest dynamic liveData / hotMessage (refreshed by update events). Mirrors the backend / iOS Live Notification contract.

LiveActivityAction

data class LiveActivityAction(val type: LiveActivityActionType, val name: String, val url: String?)

A call-to-action button rendered on the Live Activity. Mirrors an element of the backend / iOS actionSet ({ type, name, url? }). The platform-specific design block from the backend is intentionally not modeled here — Android notification actions do not support custom button styling.

LiveActivityActionType

enum LiveActivityActionType : Enum<LiveActivityActionType>

Type of a Live Activity call-to-action button. Mirrors the backend / iOS LiveNotificationActionType:

LiveActivityColor

data class LiveActivityColor(val hex: String)

A single color value resolved to a hex string. Mirrors the backend / iOS IColor type: a solid hex or a gradient (for which Android uses fromHex as the representative solid color, since android.app.Notification.ProgressStyle segments only support solid colors).

LiveActivityColorSet

data class LiveActivityColorSet(val lightMode: LiveActivityColor, val darkMode: LiveActivityColor)

Light / dark variant pair for a color. Mirrors the backend / iOS IColorSet ({ lightMode, darkMode }).

LiveActivityEvent

enum LiveActivityEvent : Enum<LiveActivityEvent>

Lifecycle event delivered in the event field of a Live Notification push. Mirrors the backend / iOS contract (start / update / end).

LiveActivityStatus

enum LiveActivityStatus : Enum<LiveActivityStatus>

LiveActivityTemplate

enum LiveActivityTemplate : Enum<LiveActivityTemplate>

Live Notification template identifier. Wire values mirror the backend / iOS contract (e.g. FOOTBALL_MATCH_TRACKING).

MatchPhase

enum MatchPhase : Enum<MatchPhase>

All possible phases of a football match. Wire values mirror the backend / iOS MatchPhase exactly (including the OTHER fallback bucket).