Activity

Declaration

class Activity<Attributes> where Attributes : ActivityAttributes

Mentioned in

• Displaying live data with Live Activities

Overview

The Activity object offers functionality to start, update, and end a Live Activity from within your app. You can update or end a Live Activity while your app is in the background, but you can only start a Live Activity while the app is in the foreground, unless you adopt App Intents and start the Live Activity using a LiveActivityIntent.

Additionally, Activity offers functionality to observe changes to:

• The Live Activity

• The Live Activity’s state in its life cycle

• A person’s permission to start Live Activities

• The Live Activity’s push token if you configure it to receive updates through ActivityKit push notifications.

To observe these changes, use the asynchronous sequences the activity object offers; for example, use the activityStateUpdates sequence to observe changes to the state of a Live Activity.

Topics

Starting a Live Activity

• request(attributes:content:pushType:)
• request(attributes:content:pushType:style:)
• request(attributes:content:pushType:style:alertConfiguration:start:)
• request(attributes:content:pushType:style:alertConfiguration:startDate:)
• attributes
• ActivityAttributes
• ActivityStyle
• content
• ActivityContent
• Activity.ContentState
• PushType
• ActivityAuthorizationError

Updating a Live Activity

• update(_:)
• update(_:alertConfiguration:)
• AlertConfiguration
• update(_:alertConfiguration:timestamp:)

Ending a Live Activity

• end(_:dismissalPolicy:)
• ActivityUIDismissalPolicy
• end(_:dismissalPolicy:timestamp:)

Observing Live Activity content changes

• contentUpdates
• Activity.ContentUpdates

Observing the Live Activity life cycle

• activityState
• ActivityState
• activityStateUpdates
• Activity.ActivityStateUpdates

Using ActivityKit push notifications

• pushToken
• pushTokenUpdates
• Activity.PushTokenUpdates
• pushToStartToken
• pushToStartTokenUpdates

Checking user authorization

• ActivityAuthorizationInfo

Accessing Live Activities

• activities
• activityUpdates
• Activity.ActivityUpdates

Identifying a Live Activity

• id
• id

Deprecated

• Deprecated symbols

Relationships

Conforms To

• Identifiable

See Also

Starting a Live Activity

• Displaying live data with Live Activities
• Starting and updating Live Activities with ActivityKit push notifications
• Emoji Rangers: Supporting Live Activities, interactivity, and animations
• NSSupportsLiveActivities
• NSSupportsLiveActivitiesFrequentUpdates