One Logo Pool Ball
ActivityKit · IOS API REFERENCE

ActivityAuthorizationInfo

class · iOS 16.1+ · SDK 27.1

final class ActivityAuthorizationInfo

An object with information about whether a person allowed your app to start Live Activities and permitted content updates with frequent ActivityKit push notifications. By default, your app can start, update, and end a Live Activity if you use ActivityKit to offer Live Activities. However, a person can deactivate Live Activities for an app in Settings. To check if your app can start, update, or end a Live Activity, use the synchronous ``ActivityKit/ActivityAuthorizationInfo/areActivitiesEnabled`` property or the asynchronous ``ActivityKit/ActivityAuthorizationInfo/activityEnablementUpdates-swift.property`` sequence. Similarly, `ActivityAuthorizationInfo` provides functionality to check whether a person has permitted your app to update Live Activities with frequent ActivityKit push notifications. To check whether you can send frequent ActivityKit push notifications to update Live Activity content, use the synchronous ``ActivityKit/ActivityAuthorizationInfo/frequentPushesEnabled`` property or the asynchronous ``ActivityKit/ActivityAuthorizationInfo/frequentPushEnablementUpdates-swift.property`` sequence. > Note: To update a Live Activity with frequent ActivityKit push notifications, add the `NSSupportsFrequentLiveActivityUpdates` key with a Boolean value of `YES` to your app's `Info.plist` file. For additional information, see <doc:starting-and-updating-live-activities-with-activitykit-push-notifications>.

Members (5)

get · iOS 16.1+

areActivitiesEnabled

TypeScript
get areActivitiesEnabled(): boolean
Swift declaration
final var areActivitiesEnabled: Bool { get }

A Boolean value that indicates whether your app can start a Live Activity.

get · iOS 16.2+

frequentPushesEnabled

TypeScript
get frequentPushesEnabled(): boolean
Swift declaration
final var frequentPushesEnabled: Bool { get }

A Boolean value that indicates whether a person permitted you to update Live Activities with frequent ActivityKit push notifications.

get · iOS 16.1+

activityEnablementUpdates

TypeScript
get activityEnablementUpdates(): ActivityAuthorizationInfo_ActivityEnablementUpdates
Swift declaration
final let activityEnablementUpdates: ActivityAuthorizationInfo.ActivityEnablementUpdates

An asynchronous sequence you use to observe whether your app can start a Live Activity.

get · iOS 16.2+

frequentPushEnablementUpdates

TypeScript
get frequentPushEnablementUpdates(): ActivityAuthorizationInfo_FrequentPushEnablementUpdates
Swift declaration
final let frequentPushEnablementUpdates: ActivityAuthorizationInfo.FrequentPushEnablementUpdates

An asynchronous sequence you use to observe whether a person permitted you to update Live Activities with frequent ActivityKit push notifications.

init · iOS 16.1+

init

TypeScript
static init(): ActivityAuthorizationInfo
Swift declaration
init()

Creates an object you use to observe user authorizations for starting Live Activities and updating them with ActivityKit push notifications.

Skipped declarations

No declarations were skipped in this snapshot.

All ActivityKit types →