AlertingContext

shouldAlert

get shouldAlert(): boolean

var shouldAlert: Bool { get }

Convenience property to determine the preferred alerting behavior based on the notification state and Focus state of the device. Accessories that do not wish to inspect individual properties on `AlertingContext` can use this property to get the preferred default alerting behavior.

isSuppressedByFocus

get isSuppressedByFocus(): boolean

var isSuppressedByFocus: Bool { get }

A flag to indicate whether a notification would be suppressed by a Focus mode on the phone.

init

static init(notificationCanAlert?: boolean, suppressedByFocus?: boolean, kind?: AlertingContext_Kind, sound?: (AlertingContext_Sound) | null): AlertingContext

init(notificationCanAlert: Bool = false, suppressedByFocus: Bool = false, kind: AlertingContext.Kind = .notification, sound: AlertingContext.Sound? = nil)

notificationCanAlert

get notificationCanAlert(): boolean

var notificationCanAlert: Bool

Flag to indicate whether a notification can alert. A notification is considered to alert when it is presented onscreen and plays sounds and/or haptics. Accessories should not alert if this flag is `false`. If this flag is `true`, an accessory may alert, but could also choose not to based on other factors specfic to the accessory. `notificationCanAlert` may be false for a newly-added notification if the notification has already alerted on another device, or if the user has configured the notification to not alert. > Note: This property is independent from whether a notification might be silenced due to the device being in a Focus mode.

notificationCanAlert

set notificationCanAlert(value: boolean)

var notificationCanAlert: Bool

Flag to indicate whether a notification can alert. A notification is considered to alert when it is presented onscreen and plays sounds and/or haptics. Accessories should not alert if this flag is `false`. If this flag is `true`, an accessory may alert, but could also choose not to based on other factors specfic to the accessory. `notificationCanAlert` may be false for a newly-added notification if the notification has already alerted on another device, or if the user has configured the notification to not alert. > Note: This property is independent from whether a notification might be silenced due to the device being in a Focus mode.

kind

get kind(): AlertingContext_Kind

var kind: AlertingContext.Kind { get }

The kind of notification this alerting context represents.

sound

get sound(): (AlertingContext_Sound) | null

var sound: AlertingContext.Sound? { get }

Indicates that this alert may play a sound. `nil` means there is no sound.