One Logo Pool Ball
AppIntents · IOS API REFERENCE

IntentChoiceOption

struct · iOS 26.0+ · SDK 27.1

struct IntentChoiceOption

A structure representing an entry in a list of options for a person to choose from before an app intent resumes its action. Each option includes display text and an optional style that influences its visual presentation. For example, an option for deleting a file might use a text and style to communicate its destructive action.

Members (4)

get · iOS 26.0+

style

TypeScript
get style(): IntentChoiceOption_Style
Swift declaration
let style: IntentChoiceOption.Style

The style applied to the option, affecting its visual appearance in the system UI.

get · iOS 26.0+

title

TypeScript
get title(): _Foundation_LocalizedStringResource
Swift declaration
let title: LocalizedStringResource

The localized text displayed for this option.

init · iOS 26.0+

init

TypeScript
static init(title: _Foundation_LocalizedStringResource, style?: IntentChoiceOption_Style): IntentChoiceOption
Swift declaration
init(title: LocalizedStringResource, style: IntentChoiceOption.Style = .default)

Creates a new option for a person to choose to continue an app intent. - Parameters: - title: The localized text to display for this option. - style: The visual style to apply; for example, ``AppIntents/IntentChoiceOption/destructive`` or ``AppIntents/IntentChoiceOption/cancel``. By default, the `style` for an intent choice option is ``AppIntents/IntentChoiceOption/default``.

get · iOS 26.0+

cancel

TypeScript
static get cancel(): IntentChoiceOption
Swift declaration
static var cancel: IntentChoiceOption { get }

A system-provided option that cancel the app intent. Selecting this option causes the ``requestChoice(between:dialog:)`` method to throw a cancellation error.

Skipped declarations

No declarations were skipped in this snapshot.

All AppIntents types →