App Services · IOS API REFERENCE

CoreSpotlight

Add search capabilities to your app, and index your content so people can find it from Spotlight and Safari.

48 types

713 callable entries

14 skipped

98% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

CSCustomAttributeKey

class · iOS 9.0+

CSImportExtension

class · iOS 15.0+

CSIndexError

struct · iOS 9.0+

CSIndexError.Code

enum · iOS 9.0+

CSIndexExtensionRequestHandler

class · iOS 9.0+

CSLocalizedString

class · iOS 9.0+

CSPerson

class · iOS 9.0+

CSSearchableIndex

class · iOS 9.0+

CSSearchableIndexDelegate

protocol · iOS 9.0+

CSSearchableIndexDescription

class · iOS 27.0+

CSSearchableItem

class · iOS 9.0+

CSSearchableItem.UpdateListenerOptions

struct · iOS 18.4+

CSSearchableItemAttributeSet

class · iOS 9.0+

CSSearchQuery

class · iOS 10.0+

CSSearchQuery.Results

struct · iOS 16.0+

CSSearchQuery.Results.AsyncIterator

typealias · iOS 16.0+

CSSearchQuery.Results.Element

typealias · iOS 16.0+

CSSearchQuery.Results.Item

struct · iOS 16.0+

CSSearchQuery.Results.Item.ID

typealias · iOS 16.0+

CSSearchQuery.Results.Iterator

struct · iOS 16.0+

CSSearchQuery.Results.Iterator.Element

typealias · iOS 16.0+

CSSearchQueryContext

class · iOS 16.0+

CSSearchQueryError

struct · iOS 10.0+

CSSearchQueryError.Code

enum · iOS 10.0+

CSSuggestion

class · iOS 16.0+

CSSuggestion.SuggestionKind

enum · iOS 16.0+

CSUserQuery

class · iOS 16.0+

CSUserQuery.Item

struct · iOS 16.0+

CSUserQuery.Item.ID

typealias · iOS 16.0+

CSUserQuery.Responses

struct · iOS 16.0+

CSUserQuery.Responses.AsyncIterator

typealias · iOS 16.0+

CSUserQuery.Responses.Element

typealias · iOS 16.0+

CSUserQuery.Responses.Iterator

struct · iOS 16.0+

CSUserQuery.Responses.Iterator.Element

typealias · iOS 16.0+

CSUserQuery.Responses.Response

enum · iOS 16.0+

CSUserQuery.Responses.Response.ID

typealias · iOS 16.0+

CSUserQuery.Suggestion

struct · iOS 16.0+

CSUserQuery.Suggestion.ID

typealias · iOS 16.0+

CSUserQuery.Suggestions

struct · iOS 16.0+

CSUserQuery.Suggestions.AsyncIterator

typealias · iOS 16.0+

CSUserQuery.Suggestions.Element

typealias · iOS 16.0+

CSUserQuery.Suggestions.Iterator

struct · iOS 16.0+

CSUserQuery.Suggestions.Iterator.Element

typealias · iOS 16.0+

CSUserQuery.UserInteractionKind

enum · iOS 18.0+

CSUserQueryContext

class · iOS 16.0+

SearchableItem

struct · iOS 27.0+

SearchableItemAttribute

struct · iOS 27.0+

SearchableItemAttribute.RawValue

typealias · iOS 27.0+

Functions and constants

get · iOS 15.0+

CSActionIdentifier

TypeScript

const CSActionIdentifier: string

Swift declaration

let CSActionIdentifier: String

get · iOS 9.0+

CSIndexErrorDomain

TypeScript

const CSIndexErrorDomain: string

Swift declaration

let CSIndexErrorDomain: String

get · iOS 9.0+

CSMailboxArchive

TypeScript

const CSMailboxArchive: string

Swift declaration

let CSMailboxArchive: String

get · iOS 9.0+

CSMailboxDrafts

TypeScript

const CSMailboxDrafts: string

Swift declaration

let CSMailboxDrafts: String

get · iOS 9.0+

CSMailboxInbox

TypeScript

const CSMailboxInbox: string

Swift declaration

let CSMailboxInbox: String

get · iOS 9.0+

CSMailboxJunk

TypeScript

const CSMailboxJunk: string

Swift declaration

let CSMailboxJunk: String

get · iOS 9.0+

CSMailboxSent

TypeScript

const CSMailboxSent: string

Swift declaration

let CSMailboxSent: String

get · iOS 9.0+

CSMailboxTrash

TypeScript

const CSMailboxTrash: string

Swift declaration

let CSMailboxTrash: String

get · iOS 10.0+

CSQueryContinuationActionType

TypeScript

const CSQueryContinuationActionType: string

Swift declaration

let CSQueryContinuationActionType: String

get · iOS 10.0+

CSSearchQueryErrorDomain

TypeScript

const CSSearchQueryErrorDomain: string

Swift declaration

let CSSearchQueryErrorDomain: String

get · iOS 10.0+

CSSearchQueryString

TypeScript

const CSSearchQueryString: string

Swift declaration

let CSSearchQueryString: String

get · iOS 9.0+

CSSearchableItemActionType

TypeScript

const CSSearchableItemActionType: string

Swift declaration

let CSSearchableItemActionType: String

get · iOS 9.0+

CSSearchableItemActivityIdentifier

TypeScript

const CSSearchableItemActivityIdentifier: string

Swift declaration

let CSSearchableItemActivityIdentifier: String

get · iOS 16.0+

suggestionHighlight

TypeScript

get suggestionHighlight(): _Foundation_NSAttributedString_Key

Swift declaration

static let suggestionHighlight: NSAttributedString.Key

get

CoreSpotlightAPIVersion

TypeScript

const CoreSpotlightAPIVersion: number

Swift declaration

var CoreSpotlightAPIVersion: Int32 { get }

get · iOS 9.0+

contentAttributeSet

TypeScript

get contentAttributeSet(): (CSSearchableItemAttributeSet) | null

Swift declaration

@NSCopying var contentAttributeSet: CSSearchableItemAttributeSet? { get set }

set · iOS 9.0+

contentAttributeSet

TypeScript

set contentAttributeSet(value: (CSSearchableItemAttributeSet) | null)

Swift declaration

@NSCopying var contentAttributeSet: CSSearchableItemAttributeSet? { get set }

Skipped declarations

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

CSCustomAttributeKey.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

CSLocalizedString.init()