orrery-core/me.kozakov.orrery.core/DayInfo

DayInfo

data class DayInfo(val label: String?, val isHoliday: Boolean = false, val tags: List<String> = emptyList(), val priority: Int = DayInfoPriority.DEFAULT, val colorArgb: Long? = null, val payload: Any? = null)

Secondary information for one day, returned by DayInfoProvider.info.

Constructors

DayInfo

constructor(label: String?, isHoliday: Boolean = false, tags: List<String> = emptyList(), priority: Int = DayInfoPriority.DEFAULT, colorArgb: Long? = null, payload: Any? = null)

Properties

colorArgb

val colorArgb: Long?

Optional label color as a packed 0xAARRGGBB ARGB value (for example 0xFFC62828), or null to use the theme color. The alpha byte is required: a 24-bit 0xRRGGBB value has alpha 0x00 and is fully transparent.

isHoliday

val isHoliday: Boolean

Whether the day is a holiday (rendered with the holiday label color).

label

val label: String?

Short text shown under the day number, or null for none.

payload

val payload: Any?

Arbitrary data attached by the provider (for example LunarDayMetadata from orrery-lunar), passed through unchanged. Read it with payloadAs.

priority

val priority: Int

Precedence when providers are combined with DayInfoProvider.plus: the entry with the higher value supplies label, colorArgb and payload. Use the tiers in DayInfoPriority; defaults to DayInfoPriority.DEFAULT.

Functions

payloadAs

inline fun <T> DayInfo.payloadAs(): T?

Type-safe extraction of DayInfo.payload, returning null if absent or of a different type.