healbesdk/com.healbe.healbesdk.business_api.alarms.data/UserAlarm

UserAlarm

class UserAlarm : Comparable<UserAlarm>

Alarm information:

Sleep quality - alarm will go off when sleep quality reach this level.
Minutes since midnight - alarm time in minutes since midnight (e.g. for alarm with alarm time 7:15 this value must be 7 * 60 + 15 = 435).
Type - alarms may be by quality or by rem phase (see Time window duration). For alarms by quality uses sleep quality value, for alarms by rem phase - minutes since midnight.
Time window duration - in how minutes earlier than alarm time (minutes since midnight) alarm by rem phase may go off if it will better or easier for user to wake up.
Repeat every week - if this value is false alarm will go off only once and for true alarm will go off on every day in days.
Days - set of days when alarm will go off. (see Repeat every week)
Enabled - if this is false alarm won't go off

NOTE: do NOT use constructor. Use Alarms.create for creating new alarm.

Types

Companion

object Companion

Properties

days

var days: MutableSet<AlarmDay>

Set of days when alarm will go off.

enabled

@get:JvmName(name = "isEnabled")

var enabled: Boolean = false

If this is false alarm won't go off.

var id: Int = 0

Get alarm id.

minutesSinceMidnight

var minutesSinceMidnight: Int = 0

Alarm time in minutes since midnight (e.g. for alarm with alarm time 7:15 this value must be 7 * 60 + 15 = 435).

repeatEveryWeek

@get:JvmName(name = "isRepeatEveryWeek")

var repeatEveryWeek: Boolean = false

If this value is false alarm will go off only once and for true alarm will go off on every day in days.

sleepQuality

var sleepQuality: Int = 0

Alarm will go off when sleep quality reach this level.

timeWindowDuration

var timeWindowDuration: Int = 0

This value specifies in how minutes earlier than alarm time (minutes since midnight) alarm by rem phase may go off if it will better or easier for user to wake up.

type

var type: AlarmType

Alarms may be by quality or by rem phase (see Time window duration).

Functions

addDay

fun addDay(day: AlarmDay)

Add alarm day.

clearDays

fun clearDays()

Clear set of days when alarm must go off.

compareTo

open operator override fun compareTo(other: UserAlarm): Int

Compares this value with the specified value for order. Returns zero if this value is equal to the specified other value, a negative number if it's less than other, or a positive number if it's greater than other.

isSame

fun isSame(another: UserAlarm?): Int

Check is this alarm and another the same.

removeDay

fun removeDay(day: AlarmDay)

Remove alarm day. NOTE: set Repeat every week in true before call to Alarms.add or Alarms.update or this value will be ignored.

Extensions

isToday

fun UserAlarm.isToday(): Boolean

Check is alarm will go off today.

UserAlarm

See also

Types

Properties

Functions

Extensions