A structure you use to configure an alert that appears when you update your Live Activity.
Members (7)
get · iOS 16.1+
body
TypeScript
get body(): _Foundation_LocalizedStringResource
Swift declaration
var body: LocalizedStringResource
The main text that appears on the alert for a Live Activity update on Apple Watch.
Apple Watch displays this string briefly as part of the alert that appears
when you update a Live Activity and choose to alert people about the update.
Choose text that's easy to read at a glance. For example, a pizza delivery app could use
"Your order will arrive in 25 minutes."
set · iOS 16.1+
body
TypeScript
set body(value: _Foundation_LocalizedStringResource)
Swift declaration
var body: LocalizedStringResource
The main text that appears on the alert for a Live Activity update on Apple Watch.
Apple Watch displays this string briefly as part of the alert that appears
when you update a Live Activity and choose to alert people about the update.
Choose text that's easy to read at a glance. For example, a pizza delivery app could use
"Your order will arrive in 25 minutes."
get · iOS 16.1+
sound
TypeScript
get sound(): AlertConfiguration_AlertSound
Swift declaration
var sound: AlertConfiguration.AlertSound
The sound the system plays when the Live Activity alert appears on a person's device.
set · iOS 16.1+
sound
TypeScript
set sound(value: AlertConfiguration_AlertSound)
Swift declaration
var sound: AlertConfiguration.AlertSound
The sound the system plays when the Live Activity alert appears on a person's device.
get · iOS 16.1+
title
TypeScript
get title(): _Foundation_LocalizedStringResource
Swift declaration
var title: LocalizedStringResource
A short title that describes the purpose of the Live Activity update on Apple Watch.
Apple Watch displays this string briefly as part of the alert that appears
when you update a Live Activity and choose to alert people about the update.
Choose text that's easy to read at a glance. For example, a pizza delivery app could use "On the way."
set · iOS 16.1+
title
TypeScript
set title(value: _Foundation_LocalizedStringResource)
Swift declaration
var title: LocalizedStringResource
A short title that describes the purpose of the Live Activity update on Apple Watch.
Apple Watch displays this string briefly as part of the alert that appears
when you update a Live Activity and choose to alert people about the update.
Choose text that's easy to read at a glance. For example, a pizza delivery app could use "On the way."
Initializes a new alert configuration for a Live Activity update.
- Parameters:
- title: The short title that describes the purpose of the Live Activity update.
- body: The main text of the alert for a Live Activity update.
- sound: The sound that the system plays when the alert appears on a person's device.