One Logo Pool Ball
X
Github
Discord

System

CoreSpotlight · IOS API REFERENCE

CSUserQuery

class · iOS 16.0+ · SDK 27.1

class CSUserQuery

Members (12)

static · iOS 18.0+

prepare

TypeScript
static prepare(): void
Swift declaration
class func prepare()
static · iOS 18.0+

prepareProtectionClasses

TypeScript
static prepareProtectionClasses(protectionClasses: Array<_Foundation_FileProtectionType>): void
Swift declaration
class func prepareProtectionClasses(_ protectionClasses: [FileProtectionType])
method · iOS 16.0+

cancel

TypeScript
cancel(): void
Swift declaration
func cancel()
init · iOS 16.0+

init

TypeScript
static init(userQueryString?: (string) | null, userQueryContext?: (CSUserQueryContext) | null): CSUserQuery
Swift declaration
init(userQueryString: String?, userQueryContext: CSUserQueryContext?)
method · iOS 16.0+

start

TypeScript
start(): void
Swift declaration
func start()
get · iOS 16.0+

foundSuggestionCount

TypeScript
get foundSuggestionCount(): number
Swift declaration
var foundSuggestionCount: Int { get }
get · iOS 16.0+

foundSuggestionsHandler

TypeScript
get foundSuggestionsHandler(): (((arg0: Array<CSSuggestion>) => Promise<void>)) | null
Swift declaration
var foundSuggestionsHandler: (([CSSuggestion]) -> Void)? { get set }
set · iOS 16.0+

foundSuggestionsHandler

TypeScript
set foundSuggestionsHandler(value: (((arg0: Array<CSSuggestion>) => void)) | null)
Swift declaration
var foundSuggestionsHandler: (([CSSuggestion]) -> Void)? { get set }
get · iOS 16.0+

suggestions

TypeScript
get suggestions(): CSUserQuery_Suggestions
Swift declaration
var suggestions: CSUserQuery.Suggestions { get }
method · iOS 18.0+

userEngaged

TypeScript
userEngagedVisibleItemsInteraction(item: CSUserQuery_Item, visibleItems: Array<CSUserQuery_Item>, interaction: CSUserQuery_UserInteractionKind): void
Swift declaration
func userEngaged(_ item: CSUserQuery.Item, visibleItems: [CSUserQuery.Item], interaction: CSUserQuery.UserInteractionKind)
method · iOS 18.0+

userEngaged

TypeScript
userEngagedVisibleSuggestionsInteraction(suggestion: CSUserQuery_Suggestion, visibleSuggestions: Array<CSUserQuery_Suggestion>, interaction: CSUserQuery_UserInteractionKind): void
Swift declaration
func userEngaged(_ suggestion: CSUserQuery.Suggestion, visibleSuggestions: [CSUserQuery.Suggestion], interaction: CSUserQuery.UserInteractionKind)
get · iOS 16.0+

responses

TypeScript
get responses(): CSUserQuery_Responses
Swift declaration
var responses: CSUserQuery.Responses { get }

Skipped declarations

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

CSUserQuery.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All CoreSpotlight types →