AppIntents · IOS API REFERENCE

IntentDescription

struct · iOS 16.0+ · SDK 27.1

struct IntentDescription

The human-readable description and metadata for an app intent.

Members (11)

get · iOS 16.0+

categoryName

TypeScript

get categoryName(): (_Foundation_LocalizedStringResource) | null

Swift declaration

var categoryName: LocalizedStringResource?

The category in which this intent will be grouped into in the Shortcuts editor.

set · iOS 16.0+

categoryName

TypeScript

set categoryName(value: (_Foundation_LocalizedStringResource) | null)

Swift declaration

var categoryName: LocalizedStringResource?

The category in which this intent will be grouped into in the Shortcuts editor.

init · iOS 16.0+

init

TypeScript

static initStringLiteral(value: string): IntentDescription

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+

searchKeywords

TypeScript

get searchKeywords(): Array<_Foundation_LocalizedStringResource>

Swift declaration

var searchKeywords: [LocalizedStringResource]

A set of keywords which, when searched in the Shortcuts editor, will reveal this intent.

set · iOS 16.0+

searchKeywords

TypeScript

set searchKeywords(value: Array<_Foundation_LocalizedStringResource>)

Swift declaration

var searchKeywords: [LocalizedStringResource]

A set of keywords which, when searched in the Shortcuts editor, will reveal this intent.

get · iOS 16.0+

descriptionText

TypeScript

get descriptionText(): _Foundation_LocalizedStringResource

Swift declaration

var descriptionText: LocalizedStringResource

A short, localized, human-readable string that describes the intent using sentence case and followed by a period.

set · iOS 16.0+

descriptionText

TypeScript

set descriptionText(value: _Foundation_LocalizedStringResource)

Swift declaration

var descriptionText: LocalizedStringResource

A short, localized, human-readable string that describes the intent using sentence case and followed by a period.

get · iOS 17.0+

resultValueName

TypeScript

get resultValueName(): (_Foundation_LocalizedStringResource) | null

Swift declaration

var resultValueName: LocalizedStringResource?

A name for the result of this intent, which will be displayed in the Shortcuts editor, such as when the output is used as a variable.

set · iOS 17.0+

resultValueName

TypeScript

set resultValueName(value: (_Foundation_LocalizedStringResource) | null)

Swift declaration

var resultValueName: LocalizedStringResource?

A name for the result of this intent, which will be displayed in the Shortcuts editor, such as when the output is used as a variable.

init · iOS 17.0+

init

TypeScript

static initCategoryNameSearchKeywordsResultValueName(descriptionText: _Foundation_LocalizedStringResource, categoryName?: (_Foundation_LocalizedStringResource) | null, searchKeywords?: Array<_Foundation_LocalizedStringResource>, resultValueName?: (_Foundation_LocalizedStringResource) | null): IntentDescription

Swift declaration

init(_ descriptionText: LocalizedStringResource, categoryName: LocalizedStringResource? = nil, searchKeywords: [LocalizedStringResource] = [], resultValueName: LocalizedStringResource?)

init · iOS 16.0+

init

TypeScript

static initCategoryNameSearchKeywords(descriptionText: _Foundation_LocalizedStringResource, categoryName?: (_Foundation_LocalizedStringResource) | null, searchKeywords?: Array<_Foundation_LocalizedStringResource>): IntentDescription

Swift declaration

init(_ descriptionText: LocalizedStringResource, categoryName: LocalizedStringResource? = nil, searchKeywords: [LocalizedStringResource] = [])

Skipped declarations

No declarations were skipped in this snapshot.

All AppIntents types →