AppIntents · IOS API REFERENCE

IntentModes

struct · iOS 26.0+ · SDK 27.1

struct IntentModes

A set of options you use to configure the runtime behavior of an app intent. This structure defines the mode values you can assign to the ``AppIntent/supportedModes`` property of your app intent. Intent modes indicate whether your app needs to run in the foreground or background when performing the app intent’s action. For example, the ``IntentModes/foreground`` mode requires your app intent code to run in a foreground process. At runtime, an app intent’s ``AppIntent/systemContext`` property also contains information about whether the process is currently running in the foreground or background. Use that information to make additional decisions about how to perform the action. For more information, see the ``IntentModes/Current`` type.

Members (5)

get · iOS 26.0+

background

TypeScript

get background(): IntentModes

Swift declaration

static var background: IntentModes { get }

A value that indicates the action can run in the background.

get · iOS 26.0+

foreground

TypeScript

get foreground(): IntentModes

Swift declaration

static var foreground: IntentModes { get }

A value that indicates the action needs to run in the foreground. This value is equivalent to the ``ForegroundMode/immediate`` mode.

static · iOS 26.0+

foreground

TypeScript

foreground60895(foregroundMode: IntentModes_ForegroundMode): IntentModes

Swift declaration

static func foreground(_ foregroundMode: IntentModes.ForegroundMode) -> IntentModes

Creates and returns a foreground mode with a specified behavior. - Parameter foregroundMode: The foreground behavior to apply to the app intent. For example, specify ``ForegroundMode/immediate`` to bring the app to the foreground before running the app intent. - Returns: A set of options that describes the foreground behavior.

init · iOS 26.0+

init

TypeScript

init(rawValue: number): IntentModes

Swift declaration

init(rawValue: Int)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 26.0+

rawValue

TypeScript

getRawValue($self: IntentModes): number

Swift declaration

let rawValue: Int

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"

Skipped declarations

No declarations were skipped in this snapshot.

All AppIntents types →