AppIntents · IOS API REFERENCE

DisplayRepresentation

struct · iOS 16.0+ · SDK 27.1

struct DisplayRepresentation

A type that describes the user interface presentation of a custom type.

Members (12)

init · iOS 16.0+

init

TypeScript

static initStringLiteral(value: string): DisplayRepresentation

Swift declaration

init(stringLiteral value: String)

Creates an instance initialized to the given string value. - Parameter value: The value of the new instance.

get · iOS 16.0+

image

TypeScript

get image(): (DisplayRepresentation_Image) | null

Swift declaration

var image: DisplayRepresentation.Image?

set · iOS 16.0+

image

TypeScript

set image(value: (DisplayRepresentation_Image) | null)

Swift declaration

var image: DisplayRepresentation.Image?

get · iOS 16.0+

title

TypeScript

get title(): _Foundation_LocalizedStringResource

Swift declaration

var title: LocalizedStringResource

set · iOS 16.0+

title

TypeScript

set title(value: _Foundation_LocalizedStringResource)

Swift declaration

var title: LocalizedStringResource

init · iOS 17.0+

init

TypeScript

static initTitleSubtitleImageSynonyms(title: _Foundation_LocalizedStringResource, subtitle?: (_Foundation_LocalizedStringResource) | null, image?: (DisplayRepresentation_Image) | null, synonyms?: Array<_Foundation_LocalizedStringResource>): DisplayRepresentation

Swift declaration

init(title: LocalizedStringResource, subtitle: LocalizedStringResource? = nil, image: DisplayRepresentation.Image? = nil, synonyms: [LocalizedStringResource] = [])

init · iOS 16.0+

init

TypeScript

static initTitleSubtitleImage(title: _Foundation_LocalizedStringResource, subtitle?: (_Foundation_LocalizedStringResource) | null, image?: (DisplayRepresentation_Image) | null): DisplayRepresentation

Swift declaration

init(title: LocalizedStringResource, subtitle: LocalizedStringResource? = nil, image: DisplayRepresentation.Image? = nil)

init · iOS 27.0+

init

TypeScript

static initTitleSubtitleSynonymsImage(title: _Foundation_LocalizedStringResource, subtitle: (_Foundation_LocalizedStringResource) | null, synonyms: Array<_Foundation_LocalizedStringResource>, image: (() => Promise<(DisplayRepresentation_Image) | null>)): DisplayRepresentation

Swift declaration

init(title: LocalizedStringResource, subtitle: LocalizedStringResource? = nil, synonyms: [LocalizedStringResource] = [], image: @escaping @Sendable () async throws -> DisplayRepresentation.Image?)

Creates a display representation whose image is produced lazily by the given closure.

get · iOS 16.0+

subtitle

TypeScript

get subtitle(): (_Foundation_LocalizedStringResource) | null

Swift declaration

var subtitle: LocalizedStringResource?

set · iOS 16.0+

subtitle

TypeScript

set subtitle(value: (_Foundation_LocalizedStringResource) | null)

Swift declaration

var subtitle: LocalizedStringResource?

get · iOS 17.0+

synonyms

TypeScript

get synonyms(): Array<_Foundation_LocalizedStringResource>

Swift declaration

var synonyms: [LocalizedStringResource]

A list of localized phrases that are synonyms of this particular display representation Example: ``` DisplayRepresentation( name: "Pizza", synonyms: ["Pie", "Za"] ) ``` In this case, "Pie", "Za" and "Pizza" are all ways to display this

set · iOS 17.0+

synonyms

TypeScript

set synonyms(value: Array<_Foundation_LocalizedStringResource>)

Swift declaration

var synonyms: [LocalizedStringResource]

Skipped declarations

No declarations were skipped in this snapshot.

All AppIntents types →