One Logo Pool Ball
AppIntents · IOS API REFERENCE

AppSchema.WhiteboardEnum

protocol · iOS 18.0+ · SDK 27.1

protocol WhiteboardEnum : AppSchema.Kind

Identifies enum schemas in the whiteboard domain.

Members (2)

get · iOS 18.0+

color

Swift declaration
var color: some AppSchemaEnum { get }

An enum schema for a color parameter. To make your app's parameter types available to Apple Intelligence, conform your ``AppEnum`` to a schema that describes a parameter's possible values to the system. If your app's functionality aligns with the `whiteboard` domain and a parameter type matches the `color` schema, you can generate the protocol conformance the schema requires for your app enum implementation with the `@AppEnum( .whiteboard.color)` Swift macro. To make your app work with Siri, see <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>. The following example shows an app enum that conforms to the `color` schema: ```swift @AppEnum(schema: .whiteboard.color) enum CanvasColor: String { case <#CanvasColor Case#> static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [ <#DisplayRepresentations#> ] } ``` The schema supports the following system experiences: - Shortcuts For more information about the App Intents framework and the experiences it supports, see <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

get · iOS 18.0+

itemType

Swift declaration
var itemType: some AppSchemaEnum { get }

An enum schema for an item type parameter. To make your app's parameter types available to Apple Intelligence, conform your ``AppEnum`` to a schema that describes a parameter's possible values to the system. If your app's functionality aligns with the `whiteboard` domain and a parameter type matches the `itemType` schema, you can generate the protocol conformance the schema requires for your app enum implementation with the `@AppEnum( .whiteboard.itemType)` Swift macro. To make your app work with Siri, see <doc://com.apple.documentation/documentation/appintents/apple-intelligence-and-siri-ai>. The following example shows an app enum that conforms to the `itemType` schema: ```swift @AppEnum(schema: .whiteboard.itemType) enum CanvasItemType: String { case <#CanvasItemType Case#> static let caseDisplayRepresentations: [Self: DisplayRepresentation] = [ <#DisplayRepresentations#> ] } ``` The schema supports the following system experiences: - Shortcuts For more information about the App Intents framework and the experiences it supports, see <doc://com.apple.documentation/documentation/appintents/getting-started-with-the-app-intents-framework>.

Skipped declarations

No declarations were skipped in this snapshot.

All AppIntents types →