App intents
Make your app’s custom actions available to the system by using app intent types.
Overview
An app intent expresses one of your app’s capabilities to the system, and contains code to perform that action. You express your app intents as types that adopt the AppIntent protocol and specify the data you need to perform the action. For specific types of actions, you might also base your intents on other App intent types. For example, if your app intent launches your app and displays some content, use the OpenIntent protocol instead. If an app intent supports system features, adopt a schema from an App schema domains.
If your app intent requires data to complete its action, specify those data requirements using parameters. An app intent parameter is a property that you annotate with the @Parameter macro. To improve the experience of specifying parameter values, include parameter summaries.
An intent returns a result to tell the system when it completes its action, and whether the action was successful or failed. A result can also provide textual or view-based content for Siri or the Shortcuts app to incorporate into conversations.
Topics
App intent definition
Creating your first app intentAccelerating app interactions with App IntentsSoup Chef with App Intents: Migrating custom intentsAppIntentApp intent types
Add-on behaviors
Parameters
Adding parameters to an app intentIntentParameterIntentParameterDependencyIntentParameterContextInputConnectionBehaviorDynamicOptionsProviderResolvers
Disambiguation
Results
IntentResultIntentDialogIntentResultContainerProvidesDialogReturnsValueShowsSnippetViewResultsCollectionOpensIntent
Dependency management
Shortcuts support
ParameterSummaryIntentParameterSummaryParameterSummaryStringParameterSummaryWhenConditionParameterSummarySwitchConditionParameterSummaryCaseConditionParameterSummaryDefaultCaseCondition