AppIntents · IOS API REFERENCE

StringSearchScope

enum · iOS 17.2+ · SDK 27.1

enum StringSearchScope

Constants that describe the types of content your app includes in search results when the search criteria is a string. When the search criteria is ``StringSearchCriteria``, use this type to specify the types of content your app searches. For most types of content, use the ``StringSearchScope/general`` option, which covers a broad range of content. If your app also searches media types, specify one or more of the other options.

Members (7)

get · iOS 17.2+

typeDisplayRepresentation

TypeScript

get typeDisplayRepresentation(): TypeDisplayRepresentation

Swift declaration

static var typeDisplayRepresentation: TypeDisplayRepresentation

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

set · iOS 17.2+

typeDisplayRepresentation

TypeScript

set typeDisplayRepresentation(value: TypeDisplayRepresentation)

Swift declaration

static var typeDisplayRepresentation: TypeDisplayRepresentation

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

get · iOS 17.2+

caseDisplayRepresentations

TypeScript

get caseDisplayRepresentations(): NativeMap<StringSearchScope, DisplayRepresentation>

Swift declaration

static var caseDisplayRepresentations: [StringSearchScope : DisplayRepresentation]

A dictionary that maps each value to the visual elements that represent it.

set · iOS 17.2+

caseDisplayRepresentations

TypeScript

set caseDisplayRepresentations(value: NativeMap<StringSearchScope, DisplayRepresentation>)

Swift declaration

static var caseDisplayRepresentations: [StringSearchScope : DisplayRepresentation]

A dictionary that maps each value to the visual elements that represent it.

get · iOS 17.2+

allCases

TypeScript

get allCases(): Array<StringSearchScope>

Swift declaration

nonisolated static var allCases: [StringSearchScope] { get }

A collection of all values of this type.

init · iOS 17.2+

init

TypeScript

init(rawValue: string): (StringSearchScope) | null

Swift declaration

init?(rawValue: String)

Creates a new instance with the specified raw value. If there is no value of the type that corresponds with the specified raw value, this initializer returns `nil`. For example: enum PaperSize: String { case A4, A5, Letter, Legal } print(PaperSize(rawValue: "Legal")) // Prints "Optional(PaperSize.Legal)" print(PaperSize(rawValue: "Tabloid")) // Prints "nil" - Parameter rawValue: The raw value to use for the new instance.

get · iOS 17.2+

rawValue

TypeScript

getRawValue($self: StringSearchScope): string

Swift declaration

var rawValue: String { get }

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 →