API clients / Swift

Upgrade the Swift API clients to v9

The latest major version of the algoliasearch-client-swift package is v9. This page lists the breaking changes since the last release, v8.

Method changes overview

The following table has links for all methods and their replacements

Search API client

v8 (legacy) v9 (latest)
client.addAPIKey → client.addApiKey
client.addAPIKey.wait → client.waitForApiKey
client.assignUser → client.assignUserId
client.assignUsers → client.batchAssignUserIds
client.clearDictionaryEntries → client.batchDictionaryEntries
client.copyIndex → client.operationIndex
client.copyRules → client.operationIndex
client.copySynonyms → client.operationIndex
client.deleteAPIKey → client.deleteApiKey
client.deleteDictionaryEntries → client.batchDictionaryEntries
client.generateSecuredAPIKey → client.generateSecuredApiKey
client.getAPIKey → client.getApiKey
client.getSecuredAPIKeyRemainingValidity → client.getSecuredApiKeyRemainingValidity
client.getTopUser → client.getTopUserIds
client.getUser → client.getUserId
client.listAPIKeys → client.listApiKeys
client.listIndices → client.listIndices
client.listUsers → client.listUserIds
client.moveIndex → client.operationIndex
client.batch → client.multipleBatch
client.multipleQueries → client.search
client.removeUser → client.removeUserId
client.replaceDictionaryEntries → client.batchDictionaryEntries
client.restoreAPIKey → client.restoreApiKey
client.saveDictionaryEntries → client.batchDictionaryEntries
client.searchUser → client.searchUserIds
client.updateAPIKey → client.updateApiKey
index.batch → client.batch
index.browse → client.browseObjects
index.browseRules → client.browseRules
index.browseSynonyms → client.browseSynonyms
index.clearObjects → client.clearObjects
index.clearRules → client.clearRules
index.clearSynonyms → client.clearSynonyms
index.copySettings → client.operationIndex
index.delete → client.deleteIndex
index.deleteBy → client.deleteBy
index.deleteObject → client.deleteObject
index.deleteObjects → client.deleteObjects
index.deleteRule → client.deleteRule
index.deleteSynonym → client.deleteSynonym
index.findObject → client.searchSingleIndex
index.getObject → client.getObject
index.getObjects → client.getObjects
index.getRule → client.getRule
index.getSettings → client.getSettings
index.getSynonym → client.getSynonym
index.getTask → client.getTask
index.partialUpdateObject → client.partialUpdateObject
index.partialUpdateObjects → client.partialUpdateObjects
index.replaceAllObjects → client.replaceAllObjects
index.replaceAllRules → client.saveRules
index.replaceAllSynonyms → client.saveSynonyms
index.saveObject → client.saveObject
index.saveObjects → client.saveObjects
index.saveRule → client.saveRule
index.saveRules → client.saveRules
index.saveSynonym → client.saveSynonym
index.saveSynonyms → client.saveSynonyms
index.search → client.searchSingleIndex
index.searchForFacetValues → client.searchForFacetValues
index.searchRules → client.searchRules
index.searchSynonyms → client.searchSynonyms
index.setSettings → client.setSettings
index.{operation}.wait → client.waitForTask

Recommend API client

v8 (legacy) v9 (latest)
client.getFrequentlyBoughtTogether → client.getRecommendations
client.getRecommendations → client.getRecommendations
client.getRelatedProducts → client.getRecommendations

Removal of InitIndex

All methods are methods of a client instance. The initIndex method of the SearchClient class has been removed. Instead, all methods require a indexName parameter.

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13

// v8
let client = SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
let index = client.index(withName: "ALGOLIA_INDEX_NAME")
index.search(query: "QUERY")

// v9
let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
try await client.searchSingleIndex(
    indexName: "ALGOLIA_INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(
        SearchSearchParamsObject(query: "QUERY")
    )
)

Wait for tasks

The Wait method has been removed. Instead, use one of the following helpers:

Copy or moving indices, settings, synonyms, or rules

Use the operationIndex method, which replaces the following methods:

  • copyIndex
  • moveIndex
  • copyRules
  • copySynonyms
  • copySettings
Did you find this page helpful?
Swift API clients v9