One Logo Pool Ball
App Services · IOS API REFERENCE

AppIntents

Make content and actions discoverable by Apple Intelligence and support system experiences like Siri, Spotlight, Shortcuts, and widgets.

721 types

944 callable entries

2,732 skipped

26% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

AnyEntityQueryComparator

struct · iOS 16.0+

AnyIntentValue

protocol · iOS 16.0+

AppDependency

class · iOS 16.0+

AppDependencyManager

class · iOS 16.0+

AppDependencyManager.Error

enum · iOS 16.0+

AppEntity

protocol · iOS 16.0+

AppEntity.Property

typealias · iOS 16.0+

AppEntity.ValueRepresentation

typealias · iOS 26.4+

AppEntityAnnotatable

protocol · iOS 18.2+

AppEntityContext

struct · iOS 27.0+

AppEntityUIElement

struct · iOS 18.4+

AppEntityUIElement.State

struct · iOS 18.4+

AppEntityUIElementsContext

struct · iOS 18.4+

AppEntityUIElementsContext.ElementsRequest

enum · iOS 18.4+

AppEnum

protocol · iOS 16.0+

AppIntent

protocol · iOS 16.0+

AppIntent.Case

typealias · iOS 16.0+

AppIntent.DefaultCase

typealias · iOS 16.0+

AppIntent.ExecutionTargets

typealias · iOS 27.0+

AppIntent.Option

typealias · iOS 26.0+

AppIntent.Parameter

typealias · iOS 16.0+

AppIntent.Summary

typealias · iOS 16.0+

AppIntent.Switch

typealias · iOS 16.0+

AppIntent.When

typealias · iOS 16.0+

AppIntentError

struct · iOS 16.0+

AppIntentError.PermissionRequired

enum · iOS 18.0+

AppIntentError.Unrecoverable

enum · iOS 18.0+

AppIntentError.UserActionRequired

enum · iOS 18.0+

AppIntentsExtension

protocol · iOS 16.0+

AppIntentsPackage

protocol · iOS 17.0+

AppSchema

struct · iOS 18.0+

AppSchema.AssistantIntent

protocol · iOS 26.2+

AppSchema.AudioEntity

protocol · iOS 27.0+

AppSchema.AudioEnum

protocol · iOS 27.0+

AppSchema.AudioIntent

protocol · iOS 27.0+

AppSchema.BooksEntity

protocol · iOS 18.0+

AppSchema.BooksEnum

protocol · iOS 18.0+

AppSchema.BooksIntent

protocol · iOS 18.0+

AppSchema.BrowserEntity

protocol · iOS 18.0+

AppSchema.BrowserEnum

protocol · iOS 18.0+

AppSchema.BrowserIntent

protocol · iOS 18.0+

AppSchema.CalendarEntity

protocol · iOS 27.0+

AppSchema.CalendarEnum

protocol · iOS 27.0+

AppSchema.CalendarIntent

protocol · iOS 27.0+

AppSchema.CameraEnum

protocol · iOS 18.0+

AppSchema.CameraIntent

protocol · iOS 18.0+

AppSchema.ClockEntity

protocol · iOS 27.0+

AppSchema.ClockEnum

protocol · iOS 27.0+

AppSchema.ClockIntent

protocol · iOS 27.0+

AppSchema.Entity

struct · iOS 18.0+

AppSchema.Enum

struct · iOS 18.0+

AppSchema.FilesEntity

protocol · iOS 18.0+

AppSchema.FilesIntent

protocol · iOS 18.0+

AppSchema.Intent

struct · iOS 18.0+

AppSchema.JournalEntity

protocol · iOS 18.0+

AppSchema.JournalIntent

protocol · iOS 18.0+

AppSchema.Kind

protocol · iOS 18.0+

AppSchema.MailEntity

protocol · iOS 18.0+

AppSchema.MailEnum

protocol · iOS 18.0+

AppSchema.MailIntent

protocol · iOS 18.0+

AppSchema.MapsEntity

protocol · iOS 27.0+

AppSchema.MapsEnum

protocol · iOS 27.0+

AppSchema.MapsIntent

protocol · iOS 27.0+

AppSchema.MessagesEntity

protocol · iOS 27.0+

AppSchema.MessagesEnum

protocol · iOS 27.0+

AppSchema.MessagesIntent

protocol · iOS 27.0+

AppSchema.NotesEntity

protocol · iOS 27.0+

AppSchema.NotesIntent

protocol · iOS 27.0+

AppSchema.PhoneEntity

protocol · iOS 27.0+

AppSchema.PhoneEnum

protocol · iOS 27.0+

AppSchema.PhoneIntent

protocol · iOS 27.0+

AppSchema.PhotosEntity

protocol · iOS 18.0+

AppSchema.PhotosEnum

protocol · iOS 18.0+

AppSchema.PhotosIntent

protocol · iOS 18.0+

AppSchema.PresentationEntity

protocol · iOS 18.0+

AppSchema.PresentationIntent

protocol · iOS 18.0+

AppSchema.ReaderEntity

protocol · iOS 18.0+

AppSchema.ReaderEnum

protocol · iOS 18.0+

AppSchema.ReaderIntent

protocol · iOS 18.0+

AppSchema.RemindersEntity

protocol · iOS 27.0+

AppSchema.RemindersEnum

protocol · iOS 27.0+

AppSchema.RemindersIntent

protocol · iOS 27.0+

AppSchema.SpreadsheetEntity

protocol · iOS 18.0+

AppSchema.SpreadsheetIntent

protocol · iOS 18.0+

AppSchema.SystemIntent

protocol · iOS 18.0+

AppSchema.VisualIntelligenceIntent

protocol · iOS 26.0+

AppSchema.WhiteboardEntity

protocol · iOS 18.0+

AppSchema.WhiteboardEnum

protocol · iOS 18.0+

AppSchema.WhiteboardIntent

protocol · iOS 18.0+

AppSchema.WordProcessorEntity

protocol · iOS 18.0+

AppSchema.WordProcessorIntent

protocol · iOS 18.0+

AppSchemaEntity

protocol · iOS 18.0+

AppSchemaEnum

protocol · iOS 18.0+

AppSchemaIntent

protocol · iOS 18.0+

AppShortcut

struct · iOS 16.0+

AppShortcutOptionsCollection

struct · iOS 17.0+

AppShortcutOptionsCollectionProtocol

protocol · iOS 17.0+

AppShortcutOptionsCollectionSpecification

protocol · iOS 17.0+

AppShortcutOptionsCollectionSpecificationBuilder

enum · iOS 17.0+

AppShortcutParameterPresentation

struct · iOS 17.0+

AppShortcutParameterPresentationSummary

struct · iOS 17.0+

AppShortcutParameterPresentationSummaryString

struct · iOS 17.0+

AppShortcutParameterPresentationSummaryString.ExtendedGraphemeClusterLiteralType

typealias · iOS 17.0+

AppShortcutParameterPresentationSummaryString.StringInterpolation

struct · iOS 17.0+

AppShortcutParameterPresentationSummaryString.StringInterpolation.StringLiteralType

typealias · iOS 17.0+

AppShortcutParameterPresentationSummaryString.StringLiteralType

typealias · iOS 17.0+

AppShortcutParameterPresentationSummaryString.UnicodeScalarLiteralType

typealias · iOS 17.0+

AppShortcutParameterPresentationTitle

struct · iOS 17.0+

AppShortcutParameterPresentationTitleString

struct · iOS 17.0+

AppShortcutParameterPresentationTitleString.ExtendedGraphemeClusterLiteralType

typealias · iOS 17.0+

AppShortcutParameterPresentationTitleString.StringInterpolation

struct · iOS 17.0+

AppShortcutParameterPresentationTitleString.StringInterpolation.StringLiteralType

typealias · iOS 17.0+

AppShortcutParameterPresentationTitleString.StringLiteralType

typealias · iOS 17.0+

AppShortcutParameterPresentationTitleString.UnicodeScalarLiteralType

typealias · iOS 17.0+

AppShortcutPhrase

struct · iOS 16.0+

AppShortcutPhrase.ExtendedGraphemeClusterLiteralType

typealias · iOS 16.0+

AppShortcutPhrase.StringInterpolation

struct · iOS 16.0+

AppShortcutPhrase.StringInterpolation.StringLiteralType

typealias · iOS 16.0+

AppShortcutPhrase.StringLiteralType

typealias · iOS 16.0+

AppShortcutPhrase.UnicodeScalarLiteralType

typealias · iOS 16.0+

AppShortcutPhraseToken

enum · iOS 16.0+

AppShortcutsBuilder

enum · iOS 16.0+

AppShortcutsContent

protocol · iOS 17.4+

AppShortcutsProvider

protocol · iOS 16.0+

AppShortcutsProvider.OptionsCollection

typealias · iOS 17.0+

AppShortcutsProvider.ParameterPresentation

typealias · iOS 17.0+

AppShortcutsProvider.Summary

typealias · iOS 17.0+

AppShortcutsProvider.Title

typealias · iOS 17.0+

AppUnionValue

protocol · iOS 27.0+

AppUnionValueCasesProviding

protocol · iOS 27.0+

AppValue

protocol · iOS 16.0+

Array.Result

typealias · iOS 16.0+

Array.Specification

typealias · iOS 16.0+

Array.UnderlyingSequence

typealias · iOS 16.0+

Array.UnwrappedType

typealias · iOS 16.0+

Array.ValueType

typealias · iOS 16.0+

AssistantEntity

protocol · iOS 18.0+

AssistantEnum

protocol · iOS 18.0+

AssistantIntent

protocol · iOS 18.0+

AssistantSchema

struct · iOS 18.0+

AssistantSchema.EntitySchema

struct · iOS 18.0+

AssistantSchema.EnumSchema

struct · iOS 18.0+

AssistantSchema.IntentSchema

struct · iOS 18.0+

AssistantSchemaEntity

protocol · iOS 18.0+

AssistantSchemaEnum

protocol · iOS 18.0+

AssistantSchemaIntent

protocol · iOS 18.0+

AssistantSchemas

enum · iOS 16.0+

AssistantSchemas.AssistantIntent

protocol · iOS 26.2+

AssistantSchemas.BooksEntity

protocol · iOS 16.0+

AssistantSchemas.BooksEnum

protocol · iOS 16.0+

AssistantSchemas.BooksIntent

protocol · iOS 16.0+

AssistantSchemas.BrowserEntity

protocol · iOS 16.0+

AssistantSchemas.BrowserEnum

protocol · iOS 16.0+

AssistantSchemas.BrowserIntent

protocol · iOS 16.0+

AssistantSchemas.CameraEnum

protocol · iOS 16.0+

AssistantSchemas.CameraIntent

protocol · iOS 16.0+

AssistantSchemas.Entity

protocol · iOS 16.0+

AssistantSchemas.EntitySchema

struct · iOS 16.0+

AssistantSchemas.Enum

protocol · iOS 16.0+

AssistantSchemas.EnumSchema

struct · iOS 16.0+

AssistantSchemas.FilesEntity

protocol · iOS 16.0+

AssistantSchemas.FilesIntent

protocol · iOS 16.0+

AssistantSchemas.Intent

protocol · iOS 16.0+

AssistantSchemas.IntentSchema

struct · iOS 16.0+

AssistantSchemas.JournalEntity

protocol · iOS 16.0+

AssistantSchemas.JournalIntent

protocol · iOS 16.0+

AssistantSchemas.MailEntity

protocol · iOS 16.0+

AssistantSchemas.MailIntent

protocol · iOS 16.0+

AssistantSchemas.Model

protocol · iOS 16.0+

AssistantSchemas.PhotosEntity

protocol · iOS 16.0+

AssistantSchemas.PhotosEnum

protocol · iOS 16.0+

AssistantSchemas.PhotosIntent

protocol · iOS 16.0+

AssistantSchemas.PresentationEntity

protocol · iOS 16.0+

AssistantSchemas.PresentationIntent

protocol · iOS 16.0+

AssistantSchemas.ReaderEntity

protocol · iOS 16.0+

AssistantSchemas.ReaderEnum

protocol · iOS 16.0+

AssistantSchemas.ReaderIntent

protocol · iOS 16.0+

AssistantSchemas.SpreadsheetEntity

protocol · iOS 16.0+

AssistantSchemas.SpreadsheetIntent

protocol · iOS 16.0+

AssistantSchemas.SystemIntent

protocol · iOS 16.0+

AssistantSchemas.VisualIntelligenceIntent

protocol · iOS 16.0+

AssistantSchemas.WhiteboardEntity

protocol · iOS 16.0+

AssistantSchemas.WhiteboardEnum

protocol · iOS 16.0+

AssistantSchemas.WhiteboardIntent

protocol · iOS 16.0+

AssistantSchemas.WordProcessorEntity

protocol · iOS 16.0+

AssistantSchemas.WordProcessorIntent

protocol · iOS 16.0+

AttributedString.Specification

typealias · iOS 16.0+

AttributedString.UnwrappedType

typealias · iOS 16.0+

AttributedString.ValueType

typealias · iOS 16.0+

AttributedStringFromStringResolver

struct · iOS 16.0+

AttributedStringFromStringResolver.Context

typealias · iOS 16.0+

AttributedStringFromStringResolver.Input

typealias · iOS 16.0+

AttributedStringFromStringResolver.Output

typealias · iOS 16.0+

AudioContext

struct · iOS 27.0+

AudioPlaybackIntent

protocol · iOS 17.0+

AudioRecordingIntent

protocol · iOS 18.0+

AudioStartingIntent

protocol · iOS 16.0+ · Deprecated in iOS 17.0

Bool.IntentDisplayName

struct · iOS 16.0+

Bool.Specification

typealias · iOS 16.0+

Bool.UnwrappedType

typealias · iOS 16.0+

Bool.ValueType

typealias · iOS 16.0+

BoolFromStringResolver

struct · iOS 16.0+

BoolFromStringResolver.Context

typealias · iOS 16.0+

BoolFromStringResolver.Input

typealias · iOS 16.0+

BoolFromStringResolver.Output

typealias · iOS 16.0+

Calendar.RecurrenceRule.Specification

typealias · iOS 18.2+

Calendar.RecurrenceRule.UnwrappedType

typealias · iOS 18.2+

Calendar.RecurrenceRule.ValueType

typealias · iOS 18.2+

CameraCaptureIntent

protocol · iOS 18.0+

CancellableIntent

protocol · iOS 26.4+

CaseDisplayRepresentable

protocol · iOS 16.0+

CLPlacemark.Specification

typealias · iOS 16.0+ · Deprecated in iOS 100000.0

CLPlacemark.UnwrappedType

typealias · iOS 16.0+ · Deprecated in iOS 100000.0

CLPlacemark.ValueType

typealias · iOS 16.0+ · Deprecated in iOS 100000.0

ComparableComparisonOperator

enum · iOS 16.0+

ConfirmationActionName

struct · iOS 16.0+

ConfirmationConditions

struct · iOS 18.0+

ConfirmationConditions.ArrayLiteralElement

typealias · iOS 18.0+

ConfirmationConditions.Element

typealias · iOS 18.0+

ConfirmationConditions.RawValue

typealias · iOS 18.0+

ContainsComparator

class · iOS 16.0+

ControlConfigurationIntent

protocol · iOS 18.0+

CustomAppIntentErrorConvertible

protocol · iOS 27.0+

CustomIntentMigratedAppIntent

protocol · iOS 16.0+

CustomURLRepresentationParameterConvertible

protocol · iOS 18.0+

Date.Specification

typealias · iOS 16.0+

Date.UnwrappedType

typealias · iOS 16.0+

Date.ValueType

typealias · iOS 16.0+

DateComponents.Specification

typealias · iOS 16.0+

DateComponents.UnwrappedType

typealias · iOS 16.0+

DateComponents.ValueType

typealias · iOS 16.0+

DeleteIntent

protocol · iOS 16.0+

DeprecatedAppIntent

protocol · iOS 17.0+

DisplayRepresentable

protocol · iOS 16.0+

DisplayRepresentation

struct · iOS 16.0+

DisplayRepresentation.ExtendedGraphemeClusterLiteralType

typealias · iOS 16.0+

DisplayRepresentation.Image

struct · iOS 16.0+

DisplayRepresentation.Image.DisplayStyle

struct · iOS 17.0+

DisplayRepresentation.StringLiteralType

typealias · iOS 16.0+

DisplayRepresentation.UnicodeScalarLiteralType

typealias · iOS 16.0+

Double.Specification

typealias · iOS 16.0+

Double.UnwrappedType

typealias · iOS 16.0+

Double.ValueType

typealias · iOS 16.0+

DoubleFromIntResolver

struct · iOS 16.0+

DoubleFromIntResolver.Context

typealias · iOS 16.0+

DoubleFromIntResolver.Input

typealias · iOS 16.0+

DoubleFromIntResolver.Output

typealias · iOS 16.0+

DoubleFromStringResolver

struct · iOS 16.0+

DoubleFromStringResolver.Context

typealias · iOS 16.0+

DoubleFromStringResolver.Input

typealias · iOS 16.0+

DoubleFromStringResolver.Output

typealias · iOS 16.0+

DoubleResolver

struct · iOS 16.0+

DoubleResolver.Context

typealias · iOS 16.0+

DoubleResolver.Input

typealias · iOS 16.0+

DoubleResolver.Output

typealias · iOS 16.0+

Duration.Specification

typealias · iOS 26.0+

Duration.UnwrappedType

typealias · iOS 26.0+

Duration.ValueType

typealias · iOS 26.0+

DynamicOptionsProvider

protocol · iOS 16.0+

DynamicOptionsProvider.Item

typealias · iOS 16.0+

DynamicOptionsProvider.ItemCollection

typealias · iOS 16.0+

DynamicOptionsProvider.ItemSection

typealias · iOS 16.0+

DynamicOptionsProvider.ParameterDependency

typealias · iOS 17.0+

EmptyResolverSpecification

struct · iOS 16.0+

EmptyResolverSpecification.Element

typealias · iOS 16.0+

EmptyResolverSpecification.Iterator

typealias · iOS 16.0+

EmptyResolverSpecification.Output

typealias · iOS 16.0+

EmptySnippetIntent

struct · iOS 26.0+

EmptySnippetIntent.Case

typealias · iOS 16.0+

EmptySnippetIntent.DefaultCase

typealias · iOS 16.0+

EmptySnippetIntent.Dependency

typealias · iOS 16.0+

EmptySnippetIntent.ExecutionTargets

typealias · iOS 27.0+

EmptySnippetIntent.Option

typealias · iOS 26.0+

EmptySnippetIntent.Parameter

typealias · iOS 16.0+

EmptySnippetIntent.PerformResult

typealias · iOS 26.0+

EmptySnippetIntent.Summary

typealias · iOS 16.0+

EmptySnippetIntent.SummaryContent

typealias · iOS 26.0+

EmptySnippetIntent.Switch

typealias · iOS 16.0+

EmptySnippetIntent.When

typealias · iOS 16.0+

EntityCollection

struct · iOS 27.0+

EntityCollection.ArrayLiteralElement

typealias · iOS 27.0+

EntityCollection.Element

typealias · iOS 27.0+

EntityCollection.Index

typealias · iOS 27.0+

EntityCollection.Indices

typealias · iOS 27.0+

EntityCollection.Iterator

typealias · iOS 27.0+

EntityCollection.Specification

typealias · iOS 27.0+

EntityCollection.SubSequence

typealias · iOS 27.0+

EntityCollection.UnwrappedType

typealias · iOS 27.0+

EntityCollection.ValueType

typealias · iOS 27.0+

EntityIdentifier

struct · iOS 16.0+

EntityIdentifier.Specification

typealias · iOS 16.0+

EntityIdentifier.UnwrappedType

typealias · iOS 16.0+

EntityIdentifier.ValueType

typealias · iOS 16.0+

EntityIdentifierConvertible

protocol · iOS 16.0+

EntityOwnership

struct · iOS 27.0+

EntityOwnership.ArrayLiteralElement

typealias · iOS 27.0+

EntityOwnership.Element

typealias · iOS 27.0+

EntityOwnership.RawValue

typealias · iOS 27.0+

EntityProperty

class · iOS 16.0+

EntityPropertyModifiers

struct · iOS 26.0+

EntityPropertyModifiers.ArrayLiteralElement

typealias · iOS 26.0+

EntityPropertyModifiers.Element

typealias · iOS 26.0+

EntityPropertyModifiers.RawValue

typealias · iOS 26.0+

EntityPropertyQuery

protocol · iOS 16.0+

EntityPropertyQuery.ComparatorMode

typealias · iOS 16.0+

EntityPropertyQuery.Property

typealias · iOS 16.0+

EntityPropertyQuery.QueryProperties

typealias · iOS 16.0+

EntityPropertyQuery.Sort

typealias · iOS 16.0+

EntityPropertyQuery.SortableBy

typealias · iOS 16.0+

EntityPropertyQuery.SortingOptions

typealias · iOS 16.0+

EntityQuery

protocol · iOS 16.0+

EntityQuery.ExecutionTargets

typealias · iOS 27.0+

EntityQueryComparator

class · iOS 16.0+

EntityQueryComparatorMode

enum · iOS 16.0+

EntityQueryComparatorsBuilder

enum · iOS 16.0+

EntityQueryProperties

struct · iOS 16.0+

EntityQueryPropertiesBuilder

enum · iOS 16.0+

EntityQueryProperty

class · iOS 16.0+

EntityQueryProperty.QueryComparators

typealias · iOS 16.0+

EntityQueryPropertyDeclaration

class · iOS 16.0+

EntityQuerySort

struct · iOS 16.0+

EntityQuerySort.Ordering

enum · iOS 16.0+

EntityQuerySortableByProperty

struct · iOS 16.0+

EntityQuerySortingOptions

struct · iOS 16.0+

EntityQuerySortingOptionsBuilder

enum · iOS 16.0+

EntityStringQuery

protocol · iOS 16.0+

EntityURLRepresentation

struct · iOS 18.0+

EntityURLRepresentation.ExtendedGraphemeClusterLiteralType

typealias · iOS 18.0+

EntityURLRepresentation.StringInterpolation

struct · iOS 18.0+

EntityURLRepresentation.StringInterpolation.StringLiteralType

typealias · iOS 18.0+

EntityURLRepresentation.StringInterpolation.Token

enum · iOS 18.0+

EntityURLRepresentation.StringLiteralType

typealias · iOS 18.0+

EntityURLRepresentation.UnicodeScalarLiteralType

typealias · iOS 18.0+

EnumerableEntityQuery

protocol · iOS 17.0+

EnumURLRepresentation

struct · iOS 18.0+

EnumURLRepresentation.EnumSingleURLRepresentation

struct · iOS 18.0+

EnumURLRepresentation.EnumSingleURLRepresentation.ExtendedGraphemeClusterLiteralType

typealias · iOS 18.0+

EnumURLRepresentation.EnumSingleURLRepresentation.StringInterpolation

typealias · iOS 18.0+

EnumURLRepresentation.EnumSingleURLRepresentation.StringLiteralType

typealias · iOS 18.0+

EnumURLRepresentation.EnumSingleURLRepresentation.UnicodeScalarLiteralType

typealias · iOS 18.0+

EnumURLRepresentation.ExtendedGraphemeClusterLiteralType

typealias · iOS 18.0+

EnumURLRepresentation.StringInterpolation

struct · iOS 18.0+

EnumURLRepresentation.StringInterpolation.StringLiteralType

typealias · iOS 18.0+

EnumURLRepresentation.StringInterpolation.Token

enum · iOS 18.0+

EnumURLRepresentation.StringLiteralType

typealias · iOS 18.0+

EnumURLRepresentation.UnicodeScalarLiteralType

typealias · iOS 18.0+

EqualToComparator

class · iOS 16.0+

EquatableComparisonOperator

enum · iOS 16.0+

FileEntity

protocol · iOS 18.0+

FileEntityIdentifier

struct · iOS 18.0+

FocusFilterAppContext

struct · iOS 16.0+

FocusFilterSuggestionContext

struct · iOS 16.0+

ForegroundContinuableIntent

protocol · iOS 16.4+ · Deprecated in iOS 26.0

GreaterThanComparator

class · iOS 16.0+

GreaterThanOrEqualToComparator

class · iOS 16.0+

HasPrefixComparator

class · iOS 16.0+

HasSuffixComparator

class · iOS 16.0+

HasValueComparisonOperator

enum · iOS 16.0+

IndexedEntity

protocol · iOS 18.0+

IndexedEntityQuery

protocol · iOS 27.0+

InputConnectionBehavior

enum · iOS 16.0+

InstanceDisplayRepresentable

protocol · iOS 16.0+

Int.Specification

typealias · iOS 16.0+

Int.UnwrappedType

typealias · iOS 16.0+

Int.ValueType

typealias · iOS 16.0+

IntentAuthenticationPolicy

enum · iOS 16.0+

IntentCancellationReason

struct · iOS 26.4+

IntentChoiceOption

struct · iOS 26.0+

IntentChoiceOption.Style

struct · iOS 26.0+

IntentCollectionSize

struct · iOS 17.0+

IntentCollectionSize.IntegerLiteralType

typealias · iOS 17.0+

IntentCurrencyAmount

struct · iOS 16.0+

IntentCurrencyAmount.Specification

typealias · iOS 16.0+

IntentCurrencyAmount.UnwrappedType

typealias · iOS 16.0+

IntentCurrencyAmount.ValueType

typealias · iOS 16.0+

IntentDeprecation

struct · iOS 17.0+

IntentDescription

struct · iOS 16.0+

IntentDescription.ExtendedGraphemeClusterLiteralType

typealias · iOS 16.0+

IntentDescription.StringLiteralType

typealias · iOS 16.0+

IntentDescription.UnicodeScalarLiteralType

typealias · iOS 16.0+

IntentDialog

struct · iOS 16.0+

IntentDialog.ExtendedGraphemeClusterLiteralType

typealias · iOS 16.0+

IntentDialog.StringInterpolation

typealias · iOS 16.0+

IntentDialog.StringLiteralType

typealias · iOS 16.0+

IntentDialog.UnicodeScalarLiteralType

typealias · iOS 16.0+

IntentDonationIdentifier

struct · iOS 16.0+

IntentDonationManager

struct · iOS 16.0+

IntentDonationMatchingPredicate

struct · iOS 16.0+

IntentExecutionTargets

struct · iOS 27.0+

IntentExecutionTargets.ArrayLiteralElement

typealias · iOS 27.0+

IntentExecutionTargets.Element

typealias · iOS 27.0+

IntentExecutionTargets.RawValue

typealias · iOS 27.0+

IntentFile

struct · iOS 16.0+

IntentFile.IntentFileError

enum · iOS 16.0+

IntentFile.Specification

typealias · iOS 16.0+

IntentFile.UnwrappedType

typealias · iOS 16.0+

IntentFile.ValueType

typealias · iOS 16.0+

IntentItem

struct · iOS 16.0+

IntentItem.Builder

enum · iOS 16.0+

IntentItemCollection

struct · iOS 16.0+

IntentItemSection

struct · iOS 16.0+

IntentItemSection.Builder

enum · iOS 16.0+

IntentModes

struct · iOS 26.0+

IntentModes.ArrayLiteralElement

typealias · iOS 26.0+

IntentModes.Current

struct · iOS 26.0+

IntentModes.Element

typealias · iOS 26.0+

IntentModes.ForegroundMode

struct · iOS 26.0+

IntentModes.RawValue

typealias · iOS 26.0+

IntentParameter

class · iOS 16.0+

IntentParameter.Acceleration

enum · iOS 17.0+

IntentParameter.Acceleration.AllCases

typealias · iOS 18.0+

IntentParameter.Angle

enum · iOS 17.0+

IntentParameter.Angle.AllCases

typealias · iOS 18.0+

IntentParameter.AppUnionValueComponent

enum · iOS 27.0+

IntentParameter.Area

enum · iOS 17.0+

IntentParameter.Area.AllCases

typealias · iOS 18.0+

IntentParameter.ConcentrationMass

enum · iOS 17.0+

IntentParameter.ConcentrationMass.AllCases

typealias · iOS 18.0+

IntentParameter.DateKind

enum · iOS 16.0+

IntentParameter.Dispersion

enum · iOS 17.0+

IntentParameter.Dispersion.AllCases

typealias · iOS 18.0+

IntentParameter.DoubleControlStyle

enum · iOS 16.0+

IntentParameter.Duration

enum · iOS 16.0+

IntentParameter.Duration.AllCases

typealias · iOS 18.0+

IntentParameter.DurationUnit

enum · iOS 26.0+

IntentParameter.DurationUnit.AllCases

typealias · iOS 26.0+

IntentParameter.DurationUnit.RawValue

typealias · iOS 26.0+

IntentParameter.ElectricCharge

enum · iOS 17.0+

IntentParameter.ElectricCharge.AllCases

typealias · iOS 18.0+

IntentParameter.ElectricCurrent

enum · iOS 17.0+

IntentParameter.ElectricCurrent.AllCases

typealias · iOS 18.0+

IntentParameter.ElectricPotentialDifference

enum · iOS 17.0+

IntentParameter.ElectricPotentialDifference.AllCases

typealias · iOS 18.0+

IntentParameter.ElectricResistance

enum · iOS 17.0+

IntentParameter.ElectricResistance.AllCases

typealias · iOS 18.0+

IntentParameter.Energy

enum · iOS 16.0+

IntentParameter.Energy.AllCases

typealias · iOS 18.0+

IntentParameter.Frequency

enum · iOS 17.0+

IntentParameter.Frequency.AllCases

typealias · iOS 18.0+

IntentParameter.FuelEfficiency

enum · iOS 17.0+

IntentParameter.FuelEfficiency.AllCases

typealias · iOS 18.0+

IntentParameter.Illuminance

enum · iOS 17.0+

IntentParameter.Illuminance.AllCases

typealias · iOS 18.0+

IntentParameter.InclusiveRange

typealias · iOS 16.0+

IntentParameter.InformationStorage

enum · iOS 17.0+

IntentParameter.InformationStorage.AllCases

typealias · iOS 18.0+

IntentParameter.IntControlStyle

enum · iOS 16.0+

IntentParameter.Length

enum · iOS 16.0+

IntentParameter.Length.AllCases

typealias · iOS 18.0+

IntentParameter.Mass

enum · iOS 16.0+

IntentParameter.Mass.AllCases

typealias · iOS 18.0+

IntentParameter.PlacemarkDisplayStyle

enum · iOS 16.0+

IntentParameter.Power

enum · iOS 17.0+

IntentParameter.Power.AllCases

typealias · iOS 18.0+

IntentParameter.Pressure

enum · iOS 17.0+

IntentParameter.Pressure.AllCases

typealias · iOS 18.0+

IntentParameter.Speed

enum · iOS 16.0+

IntentParameter.Speed.AllCases

typealias · iOS 18.0+

IntentParameter.Temperature

enum · iOS 16.0+

IntentParameter.Temperature.AllCases

typealias · iOS 18.0+

IntentParameter.ValueState

enum · iOS 18.2+

IntentParameter.Volume

enum · iOS 16.0+

IntentParameter.Volume.AllCases

typealias · iOS 18.0+

IntentParameterContext

struct · iOS 16.0+

IntentParameterDependency

class · iOS 17.0+

IntentParameterSummary

struct · iOS 16.0+

IntentParameterSummary.ParameterKeyPathsBuilder

enum · iOS 16.0+

IntentPaymentMethod

struct · iOS 16.0+

IntentPaymentMethod.PaymentType

enum · iOS 16.0+

IntentPaymentMethod.Specification

typealias · iOS 16.0+

IntentPaymentMethod.UnwrappedType

typealias · iOS 16.0+

IntentPaymentMethod.ValueType

typealias · iOS 16.0+

IntentPerson

struct · iOS 16.0+

IntentPerson.Handle

struct · iOS 16.0+

IntentPerson.Handle.Label

enum · iOS 16.0+

IntentPerson.Handle.Value

enum · iOS 16.0+

IntentPerson.Identifier

enum · iOS 16.0+

IntentPerson.Name

enum · iOS 16.0+

IntentPerson.ParameterMode

enum · iOS 16.0+

IntentPerson.ParameterMode.RawValue

typealias · iOS 16.0+

IntentPerson.Representation

typealias · iOS 26.0+

IntentPerson.Specification

typealias · iOS 16.0+

IntentPerson.UnwrappedType

typealias · iOS 16.0+

IntentPerson.ValueType

typealias · iOS 16.0+

IntentPrediction

struct · iOS 16.0+

IntentPredictionConfiguration

protocol · iOS 16.0+

IntentPredictionsBuilder

enum · iOS 16.0+

IntentProjection

class · iOS 17.0+

IntentResponseStream

struct · iOS 27.0+

IntentResult

protocol · iOS 16.0+

IntentResultContainer

struct · iOS 16.0+

IntentSystemContext

struct · iOS 16.0+

IntentURLRepresentation

struct · iOS 18.0+

IntentURLRepresentation.ExtendedGraphemeClusterLiteralType

typealias · iOS 18.0+

IntentURLRepresentation.StringInterpolation

struct · iOS 18.0+

IntentURLRepresentation.StringInterpolation.StringLiteralType

typealias · iOS 18.0+

IntentURLRepresentation.StringLiteralType

typealias · iOS 18.0+

IntentURLRepresentation.UnicodeScalarLiteralType

typealias · iOS 18.0+

IntentValueQuery

protocol · iOS 26.0+

IntentValueQuery.ExecutionTargets

typealias · iOS 27.0+

IntentValueRepresentation

struct · iOS 26.4+

IntentValueRepresentation.Body

typealias · iOS 26.4+

IntentWidgetFamily

enum · iOS 17.0+

IntentWidgetFamily.Specification

typealias · iOS 17.0+

IntentWidgetFamily.UnwrappedType

typealias · iOS 17.0+

IntentWidgetFamily.ValueType

typealias · iOS 17.0+

IntFromDoubleResolver

struct · iOS 16.0+

IntFromDoubleResolver.Context

typealias · iOS 16.0+

IntFromDoubleResolver.Input

typealias · iOS 16.0+

IntFromDoubleResolver.Output

typealias · iOS 16.0+

IntFromStringResolver

struct · iOS 16.0+

IntFromStringResolver.Context

typealias · iOS 16.0+

IntFromStringResolver.Input

typealias · iOS 16.0+

IntFromStringResolver.Output

typealias · iOS 16.0+

IntResolver

struct · iOS 16.0+

IntResolver.Context

typealias · iOS 16.0+

IntResolver.Input

typealias · iOS 16.0+

IntResolver.Output

typealias · iOS 16.0+

IsBetweenComparator

class · iOS 16.0+

LessThanComparator

class · iOS 16.0+

LessThanOrEqualToComparator

class · iOS 16.0+

LiveActivityIntent

protocol · iOS 17.0+

LiveActivityStartingIntent

protocol · iOS 16.1+ · Deprecated in iOS 17.0

LongRunningIntent

protocol · iOS 27.0+

LongRunningTaskOptions

struct · iOS 27.0+

LongRunningTaskOptions.ArrayLiteralElement

typealias · iOS 27.0+

LongRunningTaskOptions.Element

typealias · iOS 27.0+

LongRunningTaskOptions.RawValue

typealias · iOS 27.0+

Measurement.Specification

typealias · iOS 16.0+

Measurement.UnwrappedType

typealias · iOS 16.0+

Measurement.ValueType

typealias · iOS 16.0+

NegativeAppShortcutPhrase

struct · iOS 17.0+

NegativeAppShortcutPhrase.ExtendedGraphemeClusterLiteralType

typealias · iOS 17.0+

NegativeAppShortcutPhrase.StringInterpolation

struct · iOS 17.0+

NegativeAppShortcutPhrase.StringInterpolation.StringLiteralType

typealias · iOS 17.0+

NegativeAppShortcutPhrase.StringLiteralType

typealias · iOS 17.0+

NegativeAppShortcutPhrase.UnicodeScalarLiteralType

typealias · iOS 17.0+

NegativeAppShortcutPhrases

struct · iOS 17.0+

Never.Case

typealias · iOS 16.0+

Never.DefaultCase

typealias · iOS 16.0+

Never.Dependency

typealias · iOS 16.0+

Never.Dialog

typealias · iOS 17.0+

Never.ExecutionTargets

typealias · iOS 27.0+

Never.Intent

typealias · iOS 16.0+

Never.OpensAppIntent

typealias · iOS 17.0+

Never.Option

typealias · iOS 26.0+

Never.Parameter

typealias · iOS 16.0+

Never.PerformResult

typealias · iOS 16.0+

Never.Snippet

typealias · iOS 17.0+

Never.Specification

typealias · iOS 16.0+

Never.Summary

typealias · iOS 16.0+

Never.SummaryContent

typealias · iOS 16.0+

Never.Switch

typealias · iOS 16.0+

Never.UnwrappedType

typealias · iOS 16.0+

Never.Value

typealias · iOS 17.0+

Never.ValueType

typealias · iOS 16.0+

Never.When

typealias · iOS 16.0+

NotEqualToComparator

class · iOS 16.0+

OneOfComparisonOperator

enum · iOS 16.0+

OpenIntent

protocol · iOS 16.0+

OpensIntent

protocol · iOS 16.0+

OpenURLIntent

struct · iOS 18.0+

OpenURLIntent.Case

typealias · iOS 16.0+

OpenURLIntent.DefaultCase

typealias · iOS 16.0+

OpenURLIntent.Dependency

typealias · iOS 16.0+

OpenURLIntent.ExecutionTargets

typealias · iOS 27.0+

OpenURLIntent.Option

typealias · iOS 26.0+

OpenURLIntent.Parameter

typealias · iOS 16.0+

OpenURLIntent.PerformResult

typealias · iOS 18.0+

OpenURLIntent.Summary

typealias · iOS 16.0+

OpenURLIntent.SummaryContent

typealias · iOS 18.0+

OpenURLIntent.Switch

typealias · iOS 16.0+

OpenURLIntent.URLRepresentation

typealias · iOS 18.0+

OpenURLIntent.When

typealias · iOS 16.0+

Optional.Specification

typealias · iOS 16.0+

Optional.UnwrappedType

typealias · iOS 16.0+

Optional.ValueType

typealias · iOS 16.0+

OwnershipProvidingEntity

protocol · iOS 27.0+

ParameterSummary

protocol · iOS 16.0+

ParameterSummaryBuilder

enum · iOS 16.0+

ParameterSummaryCaseBuilder

enum · iOS 16.0+

ParameterSummaryCaseCondition

struct · iOS 16.0+

ParameterSummaryDefaultCaseCondition

struct · iOS 16.0+

ParameterSummaryString

struct · iOS 16.0+

ParameterSummaryString.ExtendedGraphemeClusterLiteralType

typealias · iOS 16.0+

ParameterSummaryString.StringInterpolation

struct · iOS 16.0+

ParameterSummaryString.StringInterpolation.StringLiteralType

typealias · iOS 16.0+

ParameterSummaryString.StringLiteralType

typealias · iOS 16.0+

ParameterSummaryString.UnicodeScalarLiteralType

typealias · iOS 16.0+

ParameterSummarySwitchCondition

struct · iOS 16.0+

ParameterSummarySwitchCondition.WidgetFamily

enum · iOS 17.0+

ParameterSummaryTupleCaseCondition

struct · iOS 16.0+

ParameterSummaryTupleCaseCondition.Summary

typealias · iOS 16.0+

ParameterSummaryWhenCondition

struct · iOS 16.0+

PauseWorkoutIntent

protocol · iOS 16.0+

PersistentlyIdentifiable

protocol · iOS 16.0+

PersonNameComponents.Specification

typealias · iOS 26.0+

PersonNameComponents.UnwrappedType

typealias · iOS 26.0+

PersonNameComponents.ValueType

typealias · iOS 26.0+

PlayVideoIntent

protocol · iOS 17.2+

PredictableIntent

protocol · iOS 16.0+

ProgressReportingIntent

protocol · iOS 17.0+

ProvidesDialog

protocol · iOS 16.0+

PushToTalkTransmissionIntent

protocol · iOS 17.4+

RangeCheckingResolver

protocol · iOS 16.0+

RangeComparableProperty

protocol · iOS 16.0+

RelevantEntities

struct · iOS 27.0+

RelevantIntent

struct · iOS 17.0+

RelevantIntentManager

class · iOS 17.0+

Resolver

protocol · iOS 16.0+

Resolver.Context

typealias · iOS 16.0+

ResolverSpecification

protocol · iOS 16.0+

ResolverSpecificationBuilder

enum · iOS 16.0+

ResolverSpecificationBuilder.Specification

struct · iOS 18.0+

ResolverSpecificationBuilder.Specification.Element

typealias · iOS 18.0+

ResolverSpecificationBuilder.Specification.Iterator

typealias · iOS 18.0+

ResultsCollection

protocol · iOS 16.0+

ResumeWorkoutIntent

protocol · iOS 16.0+

ReturnsValue

protocol · iOS 16.0+

RunSystemShortcutIntent

struct · iOS 27.0+

RunSystemShortcutIntent.Case

typealias · iOS 16.0+

RunSystemShortcutIntent.DefaultCase

typealias · iOS 16.0+

RunSystemShortcutIntent.Dependency

typealias · iOS 16.0+

RunSystemShortcutIntent.ExecutionTargets

typealias · iOS 27.0+

RunSystemShortcutIntent.Option

typealias · iOS 26.0+

RunSystemShortcutIntent.Parameter

typealias · iOS 16.0+

RunSystemShortcutIntent.PerformResult

typealias · iOS 27.0+

RunSystemShortcutIntent.Summary

typealias · iOS 16.0+

RunSystemShortcutIntent.SummaryContent

typealias · iOS 27.0+

RunSystemShortcutIntent.Switch

typealias · iOS 16.0+

RunSystemShortcutIntent.When

typealias · iOS 16.0+

SearchCriteria

protocol · iOS 17.2+

Set.Specification

typealias · iOS 16.0+

Set.UnderlyingSequence

typealias · iOS 16.0+

Set.UnwrappedType

typealias · iOS 16.0+

Set.ValueType

typealias · iOS 16.0+

SetFocusFilterIntent

protocol · iOS 16.0+

SetFocusFilterIntentError

enum · iOS 16.0+

SetValueIntent

protocol · iOS 18.0+

ShortcutTileColor

enum · iOS 16.0+

ShowInAppSearchResultsIntent

protocol · iOS 17.2+

ShowsSnippetIntent

protocol · iOS 26.0+

ShowsSnippetView

protocol · iOS 16.0+

SnippetIntent

protocol · iOS 26.0+

StartWorkoutIntent

protocol · iOS 16.0+

StaticDisplayRepresentable

protocol · iOS 16.0+

String.IntentInputOptions

struct · iOS 16.0+

String.IntentInputOptions.CapitalizationType

enum · iOS 16.0+

String.IntentInputOptions.KeyboardType

enum · iOS 16.0+

String.Specification

typealias · iOS 16.0+

String.UnwrappedType

typealias · iOS 16.0+

String.ValueType

typealias · iOS 16.0+

StringComparisonOperator

enum · iOS 16.0+

StringFromDoubleResolver

struct · iOS 16.0+

StringFromDoubleResolver.Context

typealias · iOS 16.0+

StringFromDoubleResolver.Input

typealias · iOS 16.0+

StringFromDoubleResolver.Output

typealias · iOS 16.0+

StringFromIntResolver

struct · iOS 16.0+

StringFromIntResolver.Context

typealias · iOS 16.0+

StringSearchCriteria

struct · iOS 17.2+

StringSearchCriteria.SearchScopes

typealias · iOS 17.2+

StringSearchCriteria.Specification

typealias · iOS 17.2+

StringSearchCriteria.UnwrappedType

typealias · iOS 17.2+

StringSearchCriteria.ValueType

typealias · iOS 17.2+

StringSearchCriteriaFromStringResolverSpecificification

struct · iOS 17.2+

StringSearchCriteriaFromStringResolverSpecificification.Context

typealias · iOS 16.0+

StringSearchCriteriaFromStringResolverSpecificification.Input

typealias · iOS 17.2+

StringSearchCriteriaFromStringResolverSpecificification.Output

typealias · iOS 17.2+

StringSearchScope

enum · iOS 17.2+

StringSearchScope.AllCases

typealias · iOS 17.2+

StringSearchScope.RawValue

typealias · iOS 17.2+

StringSearchScope.Specification

typealias · iOS 17.2+

StringSearchScope.UnwrappedType

typealias · iOS 17.2+

StringSearchScope.ValueType

typealias · iOS 17.2+

SyncableEntity

protocol · iOS 27.0+

SyncableEntityIdentifier

struct · iOS 27.0+

SystemIntent

protocol · iOS 16.0+

SystemShortcut

struct · iOS 27.0+

SystemShortcut.Specification

typealias · iOS 27.0+

SystemShortcut.UnwrappedType

typealias · iOS 27.0+

SystemShortcut.ValueType

typealias · iOS 27.0+

TargetContentProvidingIntent

protocol · iOS 26.0+

TransientAppEntity

protocol · iOS 16.0+

TupleIntentPrediction

struct · iOS 16.0+

TypeDisplayRepresentable

protocol · iOS 16.0+

TypeDisplayRepresentation

struct · iOS 16.0+

TypeDisplayRepresentation.ExtendedGraphemeClusterLiteralType

typealias · iOS 16.0+

TypeDisplayRepresentation.StringLiteralType

typealias · iOS 16.0+

TypeDisplayRepresentation.UnicodeScalarLiteralType

typealias · iOS 16.0+

UndoableIntent

protocol · iOS 26.0+

UniqueAppEntity

protocol · iOS 18.0+

UniqueAppEntityProvider

struct · iOS 18.0+

UniqueAppEntityProvider.DefaultValue

typealias · iOS 18.0+

UniqueAppEntityProvider.Dependency

typealias · iOS 16.0+

UniqueAppEntityProvider.Item

typealias · iOS 16.0+

UniqueAppEntityProvider.ItemCollection

typealias · iOS 16.0+

UniqueAppEntityProvider.ItemSection

typealias · iOS 16.0+

UniqueAppEntityProvider.ParameterDependency

typealias · iOS 17.0+

UniqueAppEntityProvider.Result

typealias · iOS 18.0+

UniqueAppEntityProvider.Unique

typealias · iOS 18.0+

UniqueAppEntityQuery

protocol · iOS 18.0+

URL.Specification

typealias · iOS 16.0+

URL.UnwrappedType

typealias · iOS 16.0+

URL.ValueType

typealias · iOS 16.0+

URLFromStringResolver

struct · iOS 16.0+

URLFromStringResolver.Context

typealias · iOS 16.0+

URLFromStringResolver.Input

typealias · iOS 16.0+

URLFromStringResolver.Output

typealias · iOS 16.0+

URLRepresentableEntity

protocol · iOS 18.0+

URLRepresentableEntity.URLRepresentation

typealias · iOS 18.0+

URLRepresentableEnum

protocol · iOS 18.0+

URLRepresentableEnum.URLRepresentation

typealias · iOS 18.0+

URLRepresentableIntent

protocol · iOS 18.0+

URLRepresentableIntent.URLRepresentation

typealias · iOS 18.0+

VideoCategory

enum · iOS 17.2+

VideoCategory.AllCases

typealias · iOS 17.2+

VideoCategory.RawValue

typealias · iOS 17.2+

VideoCategory.Specification

typealias · iOS 17.2+

VideoCategory.UnwrappedType

typealias · iOS 17.2+

VideoCategory.ValueType

typealias · iOS 17.2+

WidgetConfigurationIntent

protocol · iOS 17.0+

Functions and constants

get · iOS 16.0+

wrappedValue

TypeScript
get wrappedValue(): number
Swift declaration
final var wrappedValue: Value { get set }
set · iOS 16.0+

wrappedValue

TypeScript
set wrappedValue(value: number)
Swift declaration
final var wrappedValue: Value { get set }
get · iOS 16.0+

projectedValue

TypeScript
get projectedValue(): AppDependency<number>
Swift declaration
final var projectedValue: AppDependency<Value> { get }
init · iOS 16.0+

init

TypeScript
static initKeyManagerDefault(key: (unknown) | null, manager: AppDependencyManager, defaultValueProvider: (() => Promise<number>)): AppDependency<number>
Swift declaration
convenience init(key: AnyHashable? = nil, manager: AppDependencyManager = .shared, default defaultValueProvider: @escaping () async throws -> Value)
init · iOS 16.0+

init

TypeScript
static initKeyManager(key?: (unknown) | null, manager?: AppDependencyManager): AppDependency<number>
Swift declaration
convenience init(key: AnyHashable? = nil, manager: AppDependencyManager = .shared)
method · iOS 16.0+

appendInterpolation

TypeScript
appendInterpolation(token: AppShortcutPhraseToken): void
Swift declaration
mutating func appendInterpolation(_ token: AppShortcutPhraseToken)
method · iOS 16.0+

appendLiteral

TypeScript
appendLiteral(literal: string): void
Swift declaration
mutating func appendLiteral(_ literal: String)

Appends a literal segment to the interpolation. Don't call this method directly. Instead, initialize a variable or constant using a string literal with interpolated expressions. Interpolated expressions don't pass through this method; instead, Swift selects an overload of `appendInterpolation`. For more information, see the top-level `StringInterpolationProtocol` documentation. - Parameter literal: A string literal containing the characters that appear next in the string literal.

get · iOS 16.0+

errorDescription

TypeScript
get errorDescription(): (string) | null
Swift declaration
var errorDescription: String? { get }

A localized message describing what error occurred.

get · iOS 17.0+

systemImageName

TypeScript
get systemImageName(): (string) | null
Swift declaration
let systemImageName: String?
get · iOS 17.0+

title

TypeScript
get title(): _Foundation_LocalizedStringResource
Swift declaration
let title: LocalizedStringResource
method · iOS 17.0+

appendLiteral

TypeScript
appendLiteral(literal: string): void
Swift declaration
mutating func appendLiteral(_ literal: String)

Appends a literal segment to the interpolation. Don't call this method directly. Instead, initialize a variable or constant using a string literal with interpolated expressions. Interpolated expressions don't pass through this method; instead, Swift selects an overload of `appendInterpolation`. For more information, see the top-level `StringInterpolationProtocol` documentation. - Parameter literal: A string literal containing the characters that appear next in the string literal.

method · iOS 17.0+

appendLiteral

TypeScript
appendLiteral(literal: string): void
Swift declaration
mutating func appendLiteral(_ literal: String)

Appends a literal segment to the interpolation. Don't call this method directly. Instead, initialize a variable or constant using a string literal with interpolated expressions. Interpolated expressions don't pass through this method; instead, Swift selects an overload of `appendInterpolation`. For more information, see the top-level `StringInterpolationProtocol` documentation. - Parameter literal: A string literal containing the characters that appear next in the string literal.

get · iOS 16.0+

description

TypeScript
get description(): DisplayRepresentation
Swift declaration
var description: DisplayRepresentation
set · iOS 16.0+

description

TypeScript
set description(value: DisplayRepresentation)
Swift declaration
var description: DisplayRepresentation
get · iOS 16.0+

isOptional

TypeScript
get isOptional(): boolean
Swift declaration
final var isOptional: Bool { get }
get · iOS 18.4+

description

TypeScript
get description(): string
Swift declaration
final var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get · iOS 16.0+

projectedValue

TypeScript
get projectedValue(): EntityProperty<SDKHandle>
Swift declaration
final var projectedValue: EntityProperty<Value> { get }
get · iOS 16.0+

title

TypeScript
get title(): _Foundation_LocalizedStringResource
Swift declaration
final var title: LocalizedStringResource { get set }
set · iOS 16.0+

title

TypeScript
set title(value: _Foundation_LocalizedStringResource)
Swift declaration
final var title: LocalizedStringResource { get set }
get · iOS 16.0+

order

TypeScript
get order(): EntityQuerySort_Ordering<SDKHandle>
Swift declaration
let order: EntityQuerySort<Entity>.Ordering
get · iOS 16.0+

isOptional

TypeScript
get isOptional(): boolean
Swift declaration
final var isOptional: Bool { get }
get · iOS 18.2+

valueState

TypeScript
get valueState(): IntentParameter_ValueState<SDKHandle>
Swift declaration
final var valueState: IntentParameter<Value>.ValueState { get }

Check if an IntentParameter was provided an initial value

method · iOS 16.0+

requestValue

TypeScript
requestValue(dialog?: (IntentDialog) | null): NativeError
Swift declaration
final func requestValue(_ dialog: IntentDialog? = nil) -> any Error

Request a value from the user for this parameter.

get · iOS 16.0+

projectedValue

TypeScript
get projectedValue(): IntentParameter<SDKHandle>
Swift declaration
final var projectedValue: IntentParameter<Value> { get }
method · iOS 16.0+

needsValueError

TypeScript
needsValueError(dialog?: (IntentDialog) | null): AppIntentError
Swift declaration
final func needsValueError(_ dialog: IntentDialog? = nil) -> AppIntentError

Returns a `restartPerform` error with context to request a value from the user for this parameter and re-perform the intent with the new value. - Parameter dialog: a custom dialog that may be used when prompting the user for the value - Returns: an error that should be thrown within the intent `perform()` method.

get · iOS 16.0+

title

TypeScript
get title(): _Foundation_LocalizedStringResource
Swift declaration
final let title: LocalizedStringResource
get · iOS 26.0+

rawValue

TypeScript
getRawValue($self: IntentParameter_DurationUnit): string
Swift declaration
var rawValue: String { get }

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

get · iOS 27.0+

startIndex

TypeScript
get startIndex(): number
Swift declaration
var startIndex: Int { get }

The position of the first element in a nonempty collection. If the collection is empty, `startIndex` is equal to `endIndex`.

get · iOS 27.0+

count

TypeScript
get count(): number
Swift declaration
var count: Int { get }

The number of entity identifiers in this collection.

method · iOS 27.0+

index

TypeScript
index(i: number): number
Swift declaration
func index(after i: Int) -> Int

Returns the position immediately after the given index. The successor of an index must be well defined. For an index `i` into a collection `c`, calling `c.index(after: i)` returns the same index every time. - Parameter i: A valid index of the collection. `i` must be less than `endIndex`. - Returns: The index value immediately after `i`.

get · iOS 27.0+

isEmpty

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

A Boolean value that indicates whether the collection is empty. The value of this property is `true` if the collection is empty, or `false` if the collection has one or more identifiers.

get · iOS 27.0+

endIndex

TypeScript
get endIndex(): number
Swift declaration
var endIndex: Int { get }

The collection's "past the end" position---that is, the position one greater than the last valid subscript argument. When you need a range that includes the last element of a collection, use the half-open range operator (`..<`) with `endIndex`. The `..<` operator creates a range that doesn't include the upper bound, so it's always safe to use with `endIndex`. For example: let numbers = [10, 20, 30, 40, 50] if let index = numbers.firstIndex(of: 30) { print(numbers[index ..< numbers.endIndex]) } // Prints "[30, 40, 50]" If the collection is empty, `endIndex` is equal to `startIndex`.

get · iOS 17.0+

message

TypeScript
get message(): _Foundation_LocalizedStringResource
Swift declaration
var message: LocalizedStringResource

A short, localized, human-readable string that describes the deprecation of this intent using sentence case and followed by a period.

set · iOS 17.0+

message

TypeScript
set message(value: _Foundation_LocalizedStringResource)
Swift declaration
var message: LocalizedStringResource

A short, localized, human-readable string that describes the deprecation of this intent using sentence case and followed by a period.

init · iOS 17.0+

init

TypeScript
static init(message: _Foundation_LocalizedStringResource): IntentDeprecation<never>
Swift declaration
init(message: LocalizedStringResource) where ReplacementIntent == Never
get · iOS 16.0+

description

TypeScript
get description(): (DisplayRepresentation) | null
Swift declaration
var description: DisplayRepresentation?
set · iOS 16.0+

description

TypeScript
set description(value: (DisplayRepresentation) | null)
Swift declaration
var description: DisplayRepresentation?
get · iOS 16.0+

items

TypeScript
get items(): Array<IntentItem<SDKHandle>>
Swift declaration
var items: [IntentItem<Result>]
set · iOS 16.0+

items

TypeScript
set items(value: Array<IntentItem<SDKHandle>>)
Swift declaration
var items: [IntentItem<Result>]
get · iOS 16.0+

promptLabel

TypeScript
get promptLabel(): (_Foundation_LocalizedStringResource) | null
Swift declaration
var promptLabel: LocalizedStringResource?

A text prompt shown at the top of the view that presents the options.

set · iOS 16.0+

promptLabel

TypeScript
set promptLabel(value: (_Foundation_LocalizedStringResource) | null)
Swift declaration
var promptLabel: LocalizedStringResource?

A text prompt shown at the top of the view that presents the options.

get · iOS 16.0+

usesIndexedCollation

TypeScript
get usesIndexedCollation(): boolean
Swift declaration
var usesIndexedCollation: Bool

If set to true, presents the list of options with an alphabetical index on the right side of the screen (table view section index titles).

set · iOS 16.0+

usesIndexedCollation

TypeScript
set usesIndexedCollation(value: boolean)
Swift declaration
var usesIndexedCollation: Bool

If set to true, presents the list of options with an alphabetical index on the right side of the screen (table view section index titles).

get · iOS 16.0+

sections

TypeScript
get sections(): Array<IntentItemSection<SDKHandle>>
Swift declaration
var sections: [IntentItemSection<Result>]
set · iOS 16.0+

sections

TypeScript
set sections(value: Array<IntentItemSection<SDKHandle>>)
Swift declaration
var sections: [IntentItemSection<Result>]
subscript · iOS 16.0+

subscript

TypeScript
subscript(index: number): EntityQueryPropertyDeclaration<SDKHandle, unknown>
Swift declaration
subscript(index: Int) -> EntityQueryPropertyDeclaration<Entity, ComparatorMappingType> { get }
method · iOS 18.0+

appendInterpolation

TypeScript
appendInterpolation(subject: EnumURLRepresentation_StringInterpolation_Token<SDKHandle>): void
Swift declaration
mutating func appendInterpolation(_ subject: EnumURLRepresentation<Enum>.StringInterpolation.Token)
method · iOS 18.0+

appendLiteral

TypeScript
appendLiteral(literal: string): void
Swift declaration
mutating func appendLiteral(_ literal: String)

Appends a literal segment to the interpolation. Don't call this method directly. Instead, initialize a variable or constant using a string literal with interpolated expressions. Interpolated expressions don't pass through this method; instead, Swift selects an overload of `appendInterpolation`. For more information, see the top-level `StringInterpolationProtocol` documentation. - Parameter literal: A string literal containing the characters that appear next in the string literal.

get · iOS 17.2+

activityIdentifier

TypeScript
get activityIdentifier(): (string) | null
Swift declaration
var activityIdentifier: String?
set · iOS 17.2+

activityIdentifier

TypeScript
set activityIdentifier(value: (string) | null)
Swift declaration
var activityIdentifier: String?
get · iOS 16.0+

dialog

TypeScript
get dialog(): (IntentDialog) | null
Swift declaration
var dialog: IntentDialog?
set · iOS 16.0+

dialog

TypeScript
set dialog(value: (IntentDialog) | null)
Swift declaration
var dialog: IntentDialog?
get · iOS 16.0+

isOptional

TypeScript
get isOptional(): boolean
Swift declaration
var isOptional: Bool { get }
method · iOS 16.0+

needsValueError

TypeScript
needsValueError(dialog?: (IntentDialog) | null): AppIntentError
Swift declaration
func needsValueError(_ dialog: IntentDialog? = nil) -> AppIntentError

Returns a `restartPerform` error with context to request a value from the user for this parameter and re-perform the intent with the new value. - Parameter dialog: a custom dialog that may be used when prompting the user for the value - Returns: an error that should be thrown within the intent `perform()` method.

get · iOS 16.0+

title

TypeScript
get title(): _Foundation_LocalizedStringResource
Swift declaration
var title: LocalizedStringResource { get }
method · iOS 16.0+

appendLiteral

TypeScript
appendLiteral(literal: string): void
Swift declaration
mutating func appendLiteral(_ literal: String)

Appends a literal segment to the interpolation. Don't call this method directly. Instead, initialize a variable or constant using a string literal with interpolated expressions. Interpolated expressions don't pass through this method; instead, Swift selects an overload of `appendInterpolation`. For more information, see the top-level `StringInterpolationProtocol` documentation. - Parameter literal: A string literal containing the characters that appear next in the string literal.

method · iOS 18.0+

appendInterpolation

TypeScript
appendInterpolation(subject: EntityURLRepresentation_StringInterpolation_Token<SDKHandle>): void
Swift declaration
mutating func appendInterpolation(_ subject: EntityURLRepresentation<Entity>.StringInterpolation.Token)
method · iOS 18.0+

appendLiteral

TypeScript
appendLiteral(literal: string): void
Swift declaration
mutating func appendLiteral(_ literal: String)

Appends a literal segment to the interpolation. Don't call this method directly. Instead, initialize a variable or constant using a string literal with interpolated expressions. Interpolated expressions don't pass through this method; instead, Swift selects an overload of `appendInterpolation`. For more information, see the top-level `StringInterpolationProtocol` documentation. - Parameter literal: A string literal containing the characters that appear next in the string literal.

method · iOS 18.0+

appendLiteral

TypeScript
appendLiteral(literal: string): void
Swift declaration
mutating func appendLiteral(_ literal: String)

Appends a literal segment to the interpolation. Don't call this method directly. Instead, initialize a variable or constant using a string literal with interpolated expressions. Interpolated expressions don't pass through this method; instead, Swift selects an overload of `appendInterpolation`. For more information, see the top-level `StringInterpolationProtocol` documentation. - Parameter literal: A string literal containing the characters that appear next in the string literal.

get · iOS 27.0+

entityIdentifierString

TypeScript
get entityIdentifierString(): string
Swift declaration
var entityIdentifierString: String { get }

Returns the string representation of this identifier's local ID. This method requires a local ID to be present. Stable-only identifiers (created via the `@_spi(_)` initializer) should not have this method called. - Returns: The local ID's string representation - Precondition: The identifier must have a local ID

get · iOS 27.0+

description

TypeScript
get description(): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

subscript · iOS 16.0+

subscript

TypeScript
subscript(index: number): EntityQuerySortableByProperty<SDKHandle>
Swift declaration
subscript(index: Int) -> EntityQuerySortableByProperty<Entity> { get }
get · iOS 17.0+

wrappedValue

TypeScript
get wrappedValue(): (IntentProjection<SDKHandle>) | null
Swift declaration
final var wrappedValue: IntentProjection<Intent>? { get }
get · iOS 17.0+

debugDescription

TypeScript
get debugDescription(): string
Swift declaration
final var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

init · iOS 26.4+

init

TypeScript
static initExportingImporting(exporting: ((arg0: string) => Promise<IntentPerson>), importing: ((arg0: IntentPerson) => Promise<string>)): IntentValueRepresentation<string, IntentPerson>
Swift declaration
init(exporting: @escaping @Sendable (Item) async throws -> IntentValue, importing: @escaping @Sendable (IntentValue) async throws -> Item)

an entity and an `IntentPerson`. - Parameters: - exporting: A closure that converts an entity to an IntentPerson. - importing: A closure that converts an IntentPerson back to an entity. ## Example ```swift struct ContactEntity: AppEntity, Transferable { static var transferRepresentation: some TransferRepresentation { ValueRepresentation( exporting: { contact in IntentPerson( identifier: .applicationDefined(contact.id), name: .displayName(contact.name), handle: .init(emailAddress: contact.email) ) }, importing: { person in guard case let .applicationDefined(id) = person.identifier?.value else { throw ImportError.missingIdentifier } return ContactEntity( id: id, name: person.name.displayString, email: person.handle?.value ?? "" ) } ) } } ```

init · iOS 26.4+

init

TypeScript
static initExporting(exporting: ((arg0: string) => Promise<IntentPerson>)): IntentValueRepresentation<string, IntentPerson>
Swift declaration
init(exporting: @escaping @Sendable (Item) async throws -> IntentValue)

Creates a value representation that exports an entity to an `IntentPerson`. Use this initializer when you only need to export your entity to an IntentPerson, without supporting import back into your entity type. - Parameter exporting: A closure that converts an entity to an IntentPerson. This closure is called when the system needs to transfer your entity across process boundaries or export it for use by other apps or system features. ## Example ```swift struct ContactEntity: AppEntity, Transferable { static var transferRepresentation: some TransferRepresentation { IntentValueRepresentation( exporting: { entity in IntentPerson( identifier: .applicationDefined(entity.id), name: .displayName(entity.name), handle: .init(emailAddress: entity.email) ) } ) } } ```

method · iOS 16.0+

makeIterator

TypeScript
makeIterator(): SDKHandle
Swift declaration
func makeIterator() -> IndexingIterator<[any Resolver]>

Returns an iterator over the elements of this sequence.

method · iOS 18.0+

makeIterator

TypeScript
makeIterator(): SDKHandle
Swift declaration
func makeIterator() -> Array<any Resolver>.Iterator

Returns an iterator over the elements of this sequence.

get · iOS 26.0+

displayRepresentation

TypeScript
get displayRepresentation(): DisplayRepresentation
Swift declaration
var displayRepresentation: DisplayRepresentation { get }

The visual elements to display when presenting an instance of the type.

get · iOS 26.0+

typeDisplayRepresentation

TypeScript
static get typeDisplayRepresentation(): TypeDisplayRepresentation
Swift declaration
static var typeDisplayRepresentation: TypeDisplayRepresentation

A short, localized, human-readable name for the type.

set · iOS 26.0+

typeDisplayRepresentation

TypeScript
static set typeDisplayRepresentation(value: TypeDisplayRepresentation)
Swift declaration
static var typeDisplayRepresentation: TypeDisplayRepresentation

A short, localized, human-readable name for the type.

get · iOS 18.0+

urlRepresentationParameter

TypeScript
get urlRepresentationParameter(): (string) | null
Swift declaration
var urlRepresentationParameter: String? { get }

The string representation of the type’s content. Use this property to provide a string that describes your custom type. When specifying the string, use Swift interpolated values to incorporate data from any properties of your type, and specify only characters that URLs support. The following example shows a custom type that uses data from multiple properties to generate a string for URLs. ```swift struct MyCustomType: CustomURLRepresentationParameterConvertible { var name: String var id: UUID var urlRepresentationParameter: String? { "\(name)/\(id)" } } ```

static · iOS 16.0+

entityIdentifier

TypeScript
static entityIdentifier(entityIdentifierString: string): (string) | null
Swift declaration
static func entityIdentifier(for entityIdentifierString: String) -> UUID?

Identifiers should be able to initialize via a `String` format.

get · iOS 16.0+

entityIdentifierString

TypeScript
get entityIdentifierString(): string
Swift declaration
var entityIdentifierString: String { get }

The `AppEntity`'s identifier value as a `String`. Note: Due to system-imposed limitations, **the length of this value can not exceed 4096 characters**!

get · iOS 18.2+

appEntityIdentifier

TypeScript
get appEntityIdentifier(): (EntityIdentifier) | null
Swift declaration
var appEntityIdentifier: EntityIdentifier? { get set }

The identifier of an app entity that you associate with the user activity. By associating an app entity with a user activity, you make the entity discoverable by Apple Intelligence and Siri. To clear the association with the app entity, set `appEntityIdentifier` to `nil`. For more information, refer to <doc:providing-contextual-cues-to-Apple-Intelligence-and-Siri> and <doc://com.apple.documentation/documentation/appintents>.

set · iOS 18.2+

appEntityIdentifier

TypeScript
set appEntityIdentifier(value: (EntityIdentifier) | null)
Swift declaration
var appEntityIdentifier: EntityIdentifier? { get set }

The identifier of an app entity that you associate with the user activity. By associating an app entity with a user activity, you make the entity discoverable by Apple Intelligence and Siri. To clear the association with the app entity, set `appEntityIdentifier` to `nil`. For more information, refer to <doc:providing-contextual-cues-to-Apple-Intelligence-and-Siri> and <doc://com.apple.documentation/documentation/appintents>.

Skipped declarations

2,732 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CLPlacemark.typeDisplayRepresentation

The iOS SDK compiler rejected this binding: cannot find 'CoreLocation' in scope

CLPlacemark.displayRepresentation

The iOS SDK compiler rejected this binding: cannot find type 'CoreLocation' in scope

CLPlacemark.defaultResolverSpecification

The iOS SDK compiler rejected this binding: cannot find 'CoreLocation' in scope

AssistantSchemaEnum.isAssistantOnly

Static protocol requirements cannot be called through an instance.

AssistantSchemaEnum.typeDisplayRepresentation

Static protocol requirements cannot be called through an instance.

AssistantSchema.init(_:)

This parameter hides a concrete Swift type.

AssistantSchemaIntent.isAssistantOnly

Static protocol requirements cannot be called through an instance.

AssistantSchemaIntent.title

Static protocol requirements cannot be called through an instance.

AssistantSchema.init(_:)

This parameter hides a concrete Swift type.

AppShortcutParameterPresentationTitle.init(specific:generic:table:)

This declaration needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutParameterPresentationTitleString.init(_:)

The containing type needs Swift generic type arguments. (no canonical witness for Intent, Value)

AppShortcutParameterPresentationTitleString.init(stringLiteral:)

The containing type needs Swift generic type arguments. (no canonical witness for Intent, Value)

AppShortcutParameterPresentationTitleString.init(stringInterpolation:)

This declaration needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutParameterPresentationTitleString.StringInterpolation.init(literalCapacity:interpolationCount:)

The containing type needs Swift generic type arguments. (no canonical witness for Intent, Value)

AppShortcutParameterPresentationTitleString.StringInterpolation.appendInterpolation(_:)

This declaration needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutParameterPresentation.init(for:summary:optionsCollections:)

This declaration needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutPhrase.init(_:)

The containing type needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutPhrase.init(stringLiteral:)

The containing type needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutPhrase.init(stringInterpolation:)

The containing type needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutPhrase.StringInterpolation.init(literalCapacity:interpolationCount:)

The containing type needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutPhrase.StringInterpolation.appendInterpolation(_:)

This declaration needs Swift generic type arguments. (no canonical witness for Intent)

AppShortcutOptionsCollectionSpecificationBuilder.buildBlock(_:)

This declaration needs Swift generic type arguments. (no canonical witness for C0)

AssistantSchemaEntity.isAssistantOnly

Static protocol requirements cannot be called through an instance.

AssistantSchemaEntity.typeDisplayRepresentation

Static protocol requirements cannot be called through an instance.

AssistantSchema.init(_:)

This parameter hides a concrete Swift type.

AppDependency.init(key:manager:default:)

callback cannot propagate synchronous failure

AppDependencyManager.add(key:dependency:)

callback cannot propagate synchronous failure

AppDependencyManager.add(key:dependency:)

callback cannot propagate synchronous failure

AppEntity.defaultResolverSpecification

This protocol needs associated types that cannot yet cross the bridge.

AppEntity.defaultResolverSpecification

This protocol needs associated types that cannot yet cross the bridge.