AlarmKit · IOS API REFERENCE

Alarm.Schedule.Relative

struct · iOS 26.0+ · SDK 27.1

struct Relative

An object that describes when an alarm alerts, relative to the device's timezone.

Members (5)

init · iOS 26.0+

init

TypeScript

static init(time: Alarm_Schedule_Relative_Time, repeats?: Alarm_Schedule_Relative_Recurrence): Alarm_Schedule_Relative

Swift declaration

init(time: Alarm.Schedule.Relative.Time, repeats: Alarm.Schedule.Relative.Recurrence = .never)

Creates an alarm that fires at a specific time. - Parameters: - time: The time at which the alarm will alert. - repeats: The cadence at which the alarm repeats, if any.

get · iOS 26.0+

time

TypeScript

get time(): Alarm_Schedule_Relative_Time

Swift declaration

var time: Alarm.Schedule.Relative.Time

The hour and minute at which the alarm alerts, relative to the device's current timezone.

set · iOS 26.0+

time

TypeScript

set time(value: Alarm_Schedule_Relative_Time)

Swift declaration

var time: Alarm.Schedule.Relative.Time

The hour and minute at which the alarm alerts, relative to the device's current timezone.

get · iOS 26.0+

repeats

TypeScript

get repeats(): Alarm_Schedule_Relative_Recurrence

Swift declaration

var repeats: Alarm.Schedule.Relative.Recurrence

The cadence at which the alarm repeats, if any.

set · iOS 26.0+

repeats

TypeScript

set repeats(value: Alarm_Schedule_Relative_Recurrence)

Swift declaration

var repeats: Alarm.Schedule.Relative.Recurrence

The cadence at which the alarm repeats, if any.

Skipped declarations

No declarations were skipped in this snapshot.

All AlarmKit types →