Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.
Functions and constants
init · iOS 16.0+init
TypeScriptstatic init(name: string, tintColor?: (_UIKit_UIColor) | null, symbolConfiguration?: (_UIKit_UIImage_SymbolConfiguration) | null): (_AppIntents_DisplayRepresentation_Image) | null
Swift declarationinit?(systemName name: String, tintColor: UIColor? = nil, symbolConfiguration: UIImage.SymbolConfiguration? = nil)
Creates an image object backed by the given SF Symbol name, with optional configuration options.
- Parameters:
- systemName: name of the SF Symbol
- tintColor: an optional UIColor to tint the icon
- symbolConfiguration: an optional symbol configuration
get · iOS 18.4+appIntentsDataSource
TypeScriptget appIntentsDataSource(): Promise<(SDKHandle) | null>
Swift declaration@MainActor @preconcurrency weak var appIntentsDataSource: (any UITableViewAppIntentsDataSource)? { get set }
The object acting as the table view's data source for app entity identifiers that make a cell's content discoverable
by Apple Intelligence and Siri.
For more information, refer to <doc:providing-contextual-cues-to-Apple-Intelligence-and-Siri> and
<doc://com.apple.documentation/documentation/appintents>.
set · iOS 18.4+appIntentsDataSource
TypeScriptsetAppIntentsDataSource(value?: (SDKHandle) | null): Promise<void>
Swift declaration@MainActor @preconcurrency weak var appIntentsDataSource: (any UITableViewAppIntentsDataSource)? { get set }
The object acting as the table view's data source for app entity identifiers that make a cell's content discoverable
by Apple Intelligence and Siri.
For more information, refer to <doc:providing-contextual-cues-to-Apple-Intelligence-and-Siri> and
<doc://com.apple.documentation/documentation/appintents>.
get · iOS 18.4+appIntentsDataSource
TypeScriptget appIntentsDataSource(): Promise<(SDKHandle) | null>
Swift declaration@MainActor @preconcurrency weak var appIntentsDataSource: (any UICollectionViewAppIntentsDataSource)? { get set }
The object acting as the collection view's data source for app entity identifiers that
make a cell's content avdiscoverable by Apple Intelligence and Siri.
For more information, refer to <doc:providing-contextual-cues-to-Apple-Intelligence-and-Siri> and
<doc://com.apple.documentation/documentation/appintents>.
set · iOS 18.4+appIntentsDataSource
TypeScriptsetAppIntentsDataSource(value?: (SDKHandle) | null): Promise<void>
Swift declaration@MainActor @preconcurrency weak var appIntentsDataSource: (any UICollectionViewAppIntentsDataSource)? { get set }
The object acting as the collection view's data source for app entity identifiers that
make a cell's content avdiscoverable by Apple Intelligence and Siri.
For more information, refer to <doc:providing-contextual-cues-to-Apple-Intelligence-and-Siri> and
<doc://com.apple.documentation/documentation/appintents>.
get · iOS 26.0+appIntent
TypeScriptget appIntent(): Promise<(SDKHandle) | null>
Swift declaration@MainActor @preconcurrency var appIntent: (any UISceneAppIntent)? { get }
The `AppIntent` that triggered scene creation
`AppIntentSceneDelegate.scene(_:willPerform:)` will always be called after scene connection
get · iOS 18.4+appEntityIdentifier
TypeScriptget appEntityIdentifier(): Promise<(_AppIntents_EntityIdentifier) | null>
Swift declaration@MainActor @preconcurrency var appEntityIdentifier: EntityIdentifier? { get set }
The identifier of an app entity that you associate with a custom view.
Associate your view with one app entity to make it discoverable by Apple Intelligence and Siri when the view
appears onscreen. For example, when a person taps an item in a list to view the detail view for the item, expose the item
to Apple Intelligence and Siri using the `appEntityIdentifier`. If your custom view shows several
separate items; for example, if you use
a custom list implementation that manages selection states itself; use ``appEntityUIElementProvider`` to
provide the system with a list of items.
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.4+appEntityIdentifier
TypeScriptsetAppEntityIdentifier(value?: (_AppIntents_EntityIdentifier) | null): Promise<void>
Swift declaration@MainActor @preconcurrency var appEntityIdentifier: EntityIdentifier? { get set }
The identifier of an app entity that you associate with a custom view.
Associate your view with one app entity to make it discoverable by Apple Intelligence and Siri when the view
appears onscreen. For example, when a person taps an item in a list to view the detail view for the item, expose the item
to Apple Intelligence and Siri using the `appEntityIdentifier`. If your custom view shows several
separate items; for example, if you use
a custom list implementation that manages selection states itself; use ``appEntityUIElementProvider`` to
provide the system with a list of items.
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>.
get · iOS 18.4+appEntityUIElementProvider
TypeScriptget appEntityUIElementProvider(): Promise<(((arg0: _UIKit_UIView, arg1: _AppIntents_AppEntityUIElementsContext) => Promise<Array<_AppIntents_AppEntityUIElement>>)) | null>
Swift declaration@MainActor @preconcurrency var appEntityUIElementProvider: ((UIView, AppEntityUIElementsContext) -> [AppEntityUIElement])? { get set }
return AppEntityUIElement(
identifier: EntityIdentifier(
for: PhotoModel.self,
identifier: photo.id
),
bounds: photo.frame,
state: State(isSelected: photo.isSelected)
)
}
}
}
}
```
> Note: The order of the returned elements isn't relevant.
If your custom view shows content you can describe with a single app entity, use the ``appEntityIdentifier`` property instead to
associate the app entity with your custom view.
For more information, refer to <doc:providing-contextual-cues-to-Apple-Intelligence-and-Siri> and
<doc://com.apple.documentation/documentation/appintents>.
