App Intents
Expose a small, stable action layer that reflects what people want to do with
the app. Keep intents as adapters over existing domain services rather than a
second implementation of product behavior. When designing intent inputs or
service boundaries, read
Type System Discipline
and Boundary Discipline.
For mutating actions that may be retried or interrupted, read
Make Operations Idempotent
and apply it at the domain service that owns the effect.
Use the project's supported Xcode, Swift, and OS versions as the API boundary.
App Intents changes between SDK releases, so confirm version-sensitive APIs in
the installed SDK or current Apple documentation before adopting them.
Workflow
- Inspect the relevant app and extension targets, deployment versions, existing
intents, domain services, data stores, navigation, authentication, and
entitlements. Identify which process can perform the action and which target
must discover each declaration.
- Describe the user action in one sentence. Choose the system surfaces where
it is useful and decide whether it can finish in the background, needs the
foreground immediately, or may continue there later. Read Actions and
execution before implementing or
changing an intent.
- Model only the input and output the system needs. Use framework value types
or an
AppEnum for fixed choices. Read Entities and
queries when app data must be selected,
returned, searched, indexed, or shared across targets.
- Add the smallest discovery surface that makes the action useful. Read
Discovery and system surfaces
for App Shortcuts, Spotlight, widgets, controls, hardware entry points, and
shared-package registration.
- Build every target that declares or consumes the changed types. Then follow
Verification and exercise each requested system
surface. Use
verify when hands-on interaction adds confidence.
The work is complete when each requested action is discoverable from its target
surface, resolves representative parameters, runs in its intended process and
foreground mode, reports a useful result or failure, and preserves the app's
authorization and domain rules.
1---2name: app-intents3description: App Intents work on Apple platforms. Use when exposing app actions or content to Apple Intelligence, Siri, Shortcuts, Spotlight, widgets, controls, or hardware entry points; designing AppEntity queries; or diagnosing intent discovery and execution.4metadata:5 source: https://skillmd.com/skills/sreejithraman/app-intents6---78# App Intents910Expose a small, stable action layer that reflects what people want to do with11the app. Keep intents as adapters over existing domain services rather than a12second implementation of product behavior. When designing intent inputs or13service boundaries, read14[Type System Discipline](../engineering-principles/references/type-system-discipline.md)15and [Boundary Discipline](../engineering-principles/references/boundary-discipline.md).16For mutating actions that may be retried or interrupted, read17[Make Operations Idempotent](../engineering-principles/references/make-operations-idempotent.md)18and apply it at the domain service that owns the effect.1920Use the project's supported Xcode, Swift, and OS versions as the API boundary.21App Intents changes between SDK releases, so confirm version-sensitive APIs in22the installed SDK or current Apple documentation before adopting them.2324## Workflow25261. Inspect the relevant app and extension targets, deployment versions, existing27 intents, domain services, data stores, navigation, authentication, and28 entitlements. Identify which process can perform the action and which target29 must discover each declaration.302. Describe the user action in one sentence. Choose the system surfaces where31 it is useful and decide whether it can finish in the background, needs the32 foreground immediately, or may continue there later. Read [Actions and33 execution](references/actions-and-execution.md) before implementing or34 changing an intent.353. Model only the input and output the system needs. Use framework value types36 or an `AppEnum` for fixed choices. Read [Entities and37 queries](references/entities-and-queries.md) when app data must be selected,38 returned, searched, indexed, or shared across targets.394. Add the smallest discovery surface that makes the action useful. Read40 [Discovery and system surfaces](references/discovery-and-system-surfaces.md)41 for App Shortcuts, Spotlight, widgets, controls, hardware entry points, and42 shared-package registration.435. Build every target that declares or consumes the changed types. Then follow44 [Verification](references/verification.md) and exercise each requested system45 surface. Use `verify` when hands-on interaction adds confidence.4647The work is complete when each requested action is discoverable from its target48surface, resolves representative parameters, runs in its intended process and49foreground mode, reports a useful result or failure, and preserves the app's50authorization and domain rules.