AppIntents · IOS API REFERENCE

IntentPerson

struct · iOS 16.0+ · SDK 27.1

struct IntentPerson

Information that identifies a person participating in an intents-based interaction.

Members (17)

init · iOS 16.0+

init

TypeScript

static initIdentifierNameHandleAliasesIsMeImage(identifier: IntentPerson_Identifier, name: IntentPerson_Name, handle?: (IntentPerson_Handle) | null, aliases?: Array<IntentPerson_Handle>, isMe?: boolean, image?: (DisplayRepresentation_Image) | null): IntentPerson

Swift declaration

init(identifier: IntentPerson.Identifier, name: IntentPerson.Name, handle: IntentPerson.Handle?, aliases: [IntentPerson.Handle] = [], isMe: Bool = false, image: DisplayRepresentation.Image? = nil)

get · iOS 16.0+

identifier

TypeScript

get identifier(): IntentPerson_Identifier

Swift declaration

var identifier: IntentPerson.Identifier

set · iOS 16.0+

identifier

TypeScript

set identifier(value: IntentPerson_Identifier)

Swift declaration

var identifier: IntentPerson.Identifier

get · iOS 16.0+

displayRepresentation

TypeScript

get displayRepresentation(): DisplayRepresentation

Swift declaration

var displayRepresentation: DisplayRepresentation { get }

The visual elements to display when presenting an instance of the type.

get · iOS 16.0+

typeDisplayRepresentation

TypeScript

static get typeDisplayRepresentation(): TypeDisplayRepresentation

Swift declaration

static var typeDisplayRepresentation: TypeDisplayRepresentation { get }

A short, localized, human-readable name for the type.

get · iOS 16.0+

defaultResolverSpecification

TypeScript

static get defaultResolverSpecification(): EmptyResolverSpecification<IntentPerson>

Swift declaration

static var defaultResolverSpecification: EmptyResolverSpecification<IntentPerson> { get }

get · iOS 16.0+

isMe

TypeScript

get isMe(): boolean

Swift declaration

var isMe: Bool

Whether this `IntentPerson` represents the owner of the device

set · iOS 16.0+

isMe

TypeScript

set isMe(value: boolean)

Swift declaration

var isMe: Bool

Whether this `IntentPerson` represents the owner of the device

get · iOS 16.0+

name

TypeScript

get name(): IntentPerson_Name

Swift declaration

var name: IntentPerson.Name

The name of this `IntentPerson`

set · iOS 16.0+

name

TypeScript

set name(value: IntentPerson_Name)

Swift declaration

var name: IntentPerson.Name

The name of this `IntentPerson`

get · iOS 16.0+

image

TypeScript

get image(): (DisplayRepresentation_Image) | null

Swift declaration

var image: DisplayRepresentation.Image?

An image representing this `IntentPerson`

set · iOS 16.0+

image

TypeScript

set image(value: (DisplayRepresentation_Image) | null)

Swift declaration

var image: DisplayRepresentation.Image?

An image representing this `IntentPerson`

init · iOS 18.0+

init

TypeScript

static initHandle(handle: IntentPerson_Handle): IntentPerson

Swift declaration

init(handle: IntentPerson.Handle)

Initializes an `IntentPerson` from a raw handle, like a phone number or an email address. Use this initializer when the value is not linked to a known contact.

get · iOS 16.0+

handle

TypeScript

get handle(): (IntentPerson_Handle) | null

Swift declaration

var handle: IntentPerson.Handle?

The primary `Handle` used to contact this `IntentPerson`

set · iOS 16.0+

handle

TypeScript

set handle(value: (IntentPerson_Handle) | null)

Swift declaration

var handle: IntentPerson.Handle?

The primary `Handle` used to contact this `IntentPerson`

get · iOS 16.0+

aliases

TypeScript

get aliases(): Array<IntentPerson_Handle>

Swift declaration

var aliases: [IntentPerson.Handle]

Other secondary `Handle`s used to contact this `IntentPerson`, if any

set · iOS 16.0+

aliases

TypeScript

set aliases(value: Array<IntentPerson_Handle>)

Swift declaration

var aliases: [IntentPerson.Handle]

Other secondary `Handle`s used to contact this `IntentPerson`, if any

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

IntentPerson.transferRepresentation

This protocol needs associated types that cannot yet cross the bridge.

All AppIntents types →