One Logo Pool Ball
CoreSpotlight · IOS API REFERENCE

CSSearchableIndex

class · iOS 9.0+ · SDK 27.1

class CSSearchableIndex

Members (15)

static · iOS 9.0+

default

TypeScript
static default(): CSSearchableIndex
Swift declaration
class func `default`() -> Self
static · iOS 9.0+

isIndexingAvailable

TypeScript
static isIndexingAvailable(): boolean
Swift declaration
class func isIndexingAvailable() -> Bool
method · iOS 9.0+

beginBatch

TypeScript
beginBatch(): void
Swift declaration
func beginBatch()
method · iOS 9.0+

deleteAllSearchableItems

TypeScript
deleteAllSearchableItems(completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func deleteAllSearchableItems() async throws
method · iOS 9.0+

deleteSearchableItems

TypeScript
deleteSearchableItemsWithDomainIdentifiersCompletionHandler(domainIdentifiers: Array<string>, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func deleteSearchableItems(withDomainIdentifiers domainIdentifiers: [String]) async throws
method · iOS 9.0+

deleteSearchableItems

TypeScript
deleteSearchableItemsWithIdentifiersCompletionHandler(identifiers: Array<string>, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func deleteSearchableItems(withIdentifiers identifiers: [String]) async throws
method · iOS 9.0+

endBatch

TypeScript
endBatch(clientState: ArrayBuffer, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func endBatch(withClientState clientState: Data) async throws
method · iOS 18.0+

endIndexBatch

TypeScript
endIndexBatch(expectedClientState: (ArrayBuffer) | null, newClientState: ArrayBuffer, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func endIndexBatch(expectedClientState: Data?, newClientState: Data) async throws
method · iOS 9.0+

fetchLastClientState

TypeScript
fetchLastClientState(completionHandler: ((arg0: (ArrayBuffer) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func fetchLastClientState() async throws -> Data
method · iOS 9.0+

indexSearchableItems

TypeScript
indexSearchableItems(items: Array<CSSearchableItem>, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func indexSearchableItems(_ items: [CSSearchableItem]) async throws
init · iOS 9.0+

init

TypeScript
static initName(name: string): CSSearchableIndex
Swift declaration
init(name: String)
init · iOS 9.0+

init

TypeScript
static initNameProtectionClass(name: string, protectionClass?: (_Foundation_FileProtectionType) | null): CSSearchableIndex
Swift declaration
init(name: String, protectionClass: FileProtectionType?)
get · iOS 9.0+

indexDelegate

TypeScript
get indexDelegate(): (SDKHandle) | null
Swift declaration
weak var indexDelegate: (any CSSearchableIndexDelegate)? { get set }
set · iOS 9.0+

indexDelegate

TypeScript
set indexDelegate(value: (SDKHandle) | null)
Swift declaration
weak var indexDelegate: (any CSSearchableIndexDelegate)? { get set }
get · iOS 27.0+

protectionClass

TypeScript
get protectionClass(): _Foundation_FileProtectionType
Swift declaration
var protectionClass: FileProtectionType { get }

Skipped declarations

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

CSSearchableIndex.init()

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

All CoreSpotlight types →