App intents
Define the custom actions your app exposes to the system using specialized intents.
Overview
Use app intents to express your app’s capabilities to the system. An app intent includes the code you need to perform an action, and expresses the data you require from the system. The system exposes your actions directly from the Shortcuts app and in system experiences like Siri.
To define an action, create a type that adopts the AppIntent protocol, or a related protocol that provides the specific behavior you need. Annotate any key properties with the @Parameter property wrapper to let the system know you need the associated information to perform the action.
The system uses intent attributes like title and description to inform people about your intent’s functionality in the Shortcuts app. Supplement this information with IntentDescription metadata, and provide additional context through human-readable explanations of your intent’s functionality, including category information and search keywords. This metadata helps your intents appear in interfaces like the Shortcuts app and improves their discoverability.
For more information about features App Intents enables, see Making actions and content discoverable and widely available.
Topics
General actions
Specialized actions
DeleteIntentDeprecatedAppIntentForegroundContinuableIntentOpenIntentOpenURLIntentProgressReportingIntentSetValueIntentShowInAppSearchResultsIntentSnippetIntentSystemIntentTargetContentProvidingIntentUISceneAppIntentURLRepresentableIntent