requestChoice(between:dialog:view:)

Declaration

func requestChoice<Content>(between options: [IntentChoiceOption], dialog: IntentDialog? = nil, view: Content) async throws -> IntentChoiceOption where Content : View

Parameters

• options:

  An array of options to choose from. The order of options in this array determines the order of options in the UI, excluding the option to cancel the choice. The system automatically handles the placement of the cancel option according to platform conventions.

• dialog:

  Instructional text or a question to help the person to choose an option.

• view:

  A SwiftUI view that appears next to options, offering visual context that’s relevant to the decision; for example, the closure could show a preview of data.

Return Value

The value that represents the person’s selection.

Discussion

Call this method in your app intent’s perform() method when you need a person to confirm an action, disambiguate between possibilities, or select a specific variation of the intent’s behavior before proceeding.

The system presents a standard interface — for example, a modal sheet or alert — using the provided dialog, the content view for context, and buttons for each IntentChoiceOption. The app intent’s execution resumes only after the person selects an option.