ObjectiveClient

class ObjectiveClient @JvmOverloads constructor(apiKey: String, val autoUrlEncodeIds: Boolean = true, ioDispatcher: CoroutineContext = kotlinx.coroutines.Dispatchers.IO)

Constructors

Link copied to clipboard
constructor(apiKey: String, autoUrlEncodeIds: Boolean = true, ioDispatcher: CoroutineContext = kotlinx.coroutines.Dispatchers.IO)

Properties

Link copied to clipboard
Link copied to clipboard
val httpClient: ApiClient

Functions

Link copied to clipboard
suspend fun createIndex(indexConfiguration: IndexConfiguration): IndexId
Link copied to clipboard
inline suspend fun <T : Any> createObject(serializableObject: T): ObjectId
Link copied to clipboard
suspend fun deleteIndex(indexId: IndexId): Boolean
Link copied to clipboard
suspend fun deleteObject(objectId: ObjectId): Boolean
Link copied to clipboard
Link copied to clipboard
suspend fun getIndexes(): List<Index>
Link copied to clipboard
suspend fun getIndexStatus(indexId: IndexId): IndexStatuses
Link copied to clipboard
inline suspend fun <T> getObject(objectId: ObjectId): ObjectStatusContainer<T>
Link copied to clipboard
inline suspend fun <T> getObjects(includeObject: Boolean = false, includeMetadata: Boolean = false, limit: Int = 10, cursor: String? = null): List<ObjectContainer<T>>
Link copied to clipboard
inline suspend fun <T> search(indexId: IndexId, query: String, limit: Int = 10, offset: Int = 0, filterQuery: String? = null, objectFields: String? = null): SearchResultsResponse<T>
Link copied to clipboard
inline suspend fun <T : Any> upsertObject(objectId: ObjectId, serializableObject: T): ObjectId