One Logo Pool Ball
AlarmKit · IOS API REFERENCE

AlarmPresentationState.Mode.Countdown

struct · iOS 26.0+ · SDK 27.1

struct Countdown

An object that specifies a countdown is in progress.

Members (9)

init · iOS 26.0+

init

TypeScript
static init(totalCountdownDuration: number, previouslyElapsedDuration: number, startDate: globalThis.Date, fireDate: globalThis.Date): AlarmPresentationState_Mode_Countdown
Swift declaration
init(totalCountdownDuration: TimeInterval, previouslyElapsedDuration: TimeInterval, startDate: Date, fireDate: Date)

Creates an instance of a countdown. - Parameters: - totalCountdownDuration: The total duration of the countdown. - previouslyElapsedDuration: The amount of time that has passed. If the countdown was never paused or resumed, the value is zero. - startDate: The date that the countdown started. If the countdown was never paused, the date is when the countdown started. - fireDate: The date at which the countdown starts.

get · iOS 26.0+

totalCountdownDuration

TypeScript
get totalCountdownDuration(): number
Swift declaration
var totalCountdownDuration: TimeInterval

The total duration of the countdown.

set · iOS 26.0+

totalCountdownDuration

TypeScript
set totalCountdownDuration(value: number)
Swift declaration
var totalCountdownDuration: TimeInterval

The total duration of the countdown.

get · iOS 26.0+

previouslyElapsedDuration

TypeScript
get previouslyElapsedDuration(): number
Swift declaration
var previouslyElapsedDuration: TimeInterval

The amount of time that elapsed before the most recent resumption of the countdown. If the countdown was never paused or resumed, the value is zero.

set · iOS 26.0+

previouslyElapsedDuration

TypeScript
set previouslyElapsedDuration(value: number)
Swift declaration
var previouslyElapsedDuration: TimeInterval

The amount of time that elapsed before the most recent resumption of the countdown. If the countdown was never paused or resumed, the value is zero.

get · iOS 26.0+

fireDate

TypeScript
get fireDate(): globalThis.Date
Swift declaration
var fireDate: Date

The date the countdown starts. The alarm transitions to the `alerting` state.

set · iOS 26.0+

fireDate

TypeScript
set fireDate(value: globalThis.Date)
Swift declaration
var fireDate: Date

The date the countdown starts. The alarm transitions to the `alerting` state.

get · iOS 26.0+

startDate

TypeScript
get startDate(): globalThis.Date
Swift declaration
var startDate: Date

The date at which the countdown was mostly recently resumed. If the countdown was never paused, the date is when the countdown started.

set · iOS 26.0+

startDate

TypeScript
set startDate(value: globalThis.Date)
Swift declaration
var startDate: Date

The date at which the countdown was mostly recently resumed. If the countdown was never paused, the date is when the countdown started.

Skipped declarations

No declarations were skipped in this snapshot.

All AlarmKit types →