Luscii Android SDK/com.luscii.sdk.actions/Action

Action

class Action

A Luscii action, a scheduled measurement the user may take.

Actions are equal to other Actions by their id only.

Types

sealed interface Category

Category of an Action. Some are pre-defined, but dynamic values are also possible, see Dynamic.

@Serializable

data class Id : Parcelable, Serializable

class Instrument

A specification of how something can be measured.

LaunchableStatus

sealed interface LaunchableStatus

The status of whether this action is launchable.

data class Measurements(val action: Action, val completedAt: ZonedDateTime, instrumentMeasurements: List<Action.Instrument.Measurements>) : List<Action.Instrument.Measurements>

A collection of measurements per Instrument that were taken for the given action.

Properties

val category: Action.Category

Category of the action.

val completedAt: ZonedDateTime?

val icon: URI?

A link to an icon SVG file.

val id: Action.Id

val instruments: List<Action.Instrument>

val isExtra: Boolean

Whether this is a planned action that was completed as an extra self-care action.

val isPlanned: Boolean

Whether this action is planned.

val isSelfCare: Boolean

Whether this is a self-care action, meaning it was returned from Luscii.getSelfCareActions.

val name: String

Name of the action, provided in the system's language, or English as a fallback.

Functions

open operator override fun equals(other: Any?): Boolean

getLaunchableStatus

fun getLaunchableStatus(): Action.LaunchableStatus

Returns the current status of whether this action is launchable right now (using system time).

open override fun hashCode(): Int

fun isLaunchable(): Boolean

Returns true if this action is launchable right now (using system time).