LocalDataProvider

public class LocalDataProvider<Record> : IndexableDataProvider where Record : IndexableRecord, Record : SearchResult, Record : Decodable, Record : Encodable

Search records data provider with local storage

updateNotificationName
NSNotification name for built-in update notifications.
Declaration
Swift

public static var updateNotificationName: Notification.Name { get }
providerIdentifier
Provider identifier for concrete local provider
Declaration
Swift

public static var providerIdentifier: String { get }
recordsMap
Dictionary with all records
Declaration
Swift

public var recordsMap: [String : Record]
addsRecordsToInteractors
Determines if entries from the provider are added to search results
Declaration
Swift

public var addsRecordsToInteractors: Bool


                    
                    
                    persistentService

Records storage

Declaration

Swift

public let persistentService: CodablePersistentService<[Record]>?

init()
Make your own data provider of local data with built-in load/save support for Codable results.
Declaration
Swift

public init()
registerProviderInteractor(interactor:)
Register custom data provider interactor to notify search engine about object additions or changes.
Declaration
Swift

public func registerProviderInteractor(interactor providerInteractor: RecordsProviderInteractor)


                    
                    
                    resolve(suggestion:completion:)

Resolves SearchResultSuggestion into SearchResult locally.

Declaration

Swift

public func resolve(suggestion: SearchResultSuggestion, completion: (SearchResult?) -> Void)

Parameters

`suggestion`	suggestion to resolve
`completion`	completion closure


                    
                    
                    resolve(suggestion:retrieveOptions:completion:)

Resolves SearchResultSuggestion into SearchResult locally.

Declaration

Swift

public func resolve(
    suggestion: any SearchResultSuggestion,
    retrieveOptions: RetrieveOptions?,
    completion: @escaping ((any SearchResult)?) -> Void
)

Parameters

`suggestion`	suggestion to resolve
`retrieveOptions`	Define attribute sets to request additional metadata attributes
`completion`	completion closure

Service-like functionality


                    
                    
                    add(record:)

Adds record to providers storage

Declaration

Swift

public func add(record: Record)

Parameters


                                  record

entity to add


                    
                    
                    update(record:)

Add or override existoing record to provireds storage

Declaration

Swift

public func update(record: Record)

Parameters


                                  record

entirny to update


                    
                    
                    delete(recordId:)

Deletes record by id

Declaration

Swift

public func delete(recordId: String)

Parameters


                                  recordId

record id to delete

deleteAll()
Deletes all records
Declaration
Swift

public func deleteAll()