Contents

alarm(schedule:attributes:stopIntent:secondaryIntent:sound:)

Creates a configuration that behaves like a traditional alarm.

Declaration

static func alarm(schedule: Alarm.Schedule? = nil, attributes: AlarmAttributes<Metadata>, stopIntent: (any LiveActivityIntent)? = nil, secondaryIntent: (any LiveActivityIntent)? = nil, sound: AlertConfiguration.AlertSound = .default) -> AlarmManager.AlarmConfiguration<Metadata>

Parameters

  • schedule:

    The schedule for the alarm.

  • attributes:

    The attributes to use when presenting the alert.

  • stopIntent:

    The intent to execute when a person taps the stop button.

  • secondaryIntent:

    The intent to execute when a person taps the secondary button.

  • sound:

    The sound to play when the alarm fires.

Discussion

At the scheduled time, based on the schedule parameter you supply, the alarm alerts.