privmx-endpoint/com.simplito.kotlin.privmx_endpoint.modules.kvdb/KvdbApi/listEntries

listEntries

expect fun listEntries(kvdbId: String, skip: Long, limit: Long, sortOrder: String = "desc", lastId: String? = null, queryAsJson: String? = null, sortBy: String? = null): PagingList<KvdbEntry>

Gets a list of KVDB entries from a KVDB.

Return

list of KVDB entries

Parameters

kvdbId

ID of the KVDB to list KVDB entries from

skip

skip number of elements to skip from result

limit

limit of elements to return for query

sortOrder

order of elements in result ("asc" for ascending, "desc" for descending)

lastId

ID of the element from which query results should start

queryAsJson

stringified JSON object with a custom field to filter result

sortBy

field by elements are sorted in result

Throws

thrown when instance is closed.

thrown when method encounters an exception.

thrown when method encounters an unknown exception.

actual fun listEntries(kvdbId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?, queryAsJson: String?, sortBy: String?): PagingList<KvdbEntry>

Gets a list of KVDB entries from a KVDB.

Return

list of KVDB entries

Parameters

kvdbId

ID of the KVDB to list KVDB entries from

skip

skip number of elements to skip from result

limit

limit of elements to return for query

sortOrder

order of elements in result ("asc" for ascending, "desc" for descending)

lastId

ID of the element from which query results should start

queryAsJson

stringified JSON object with a custom field to filter result

sortBy

field by elements are sorted in result

Throws

thrown when instance is closed.

thrown when method encounters an exception.

thrown when method encounters an unknown exception.

@JvmOverloads
actual external fun listEntries(kvdbId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?, queryAsJson: String?, sortBy: String?): PagingList<KvdbEntry>

Gets a list of KVDB entries from a KVDB.

Return

list of KVDB entries

Parameters

kvdbId

ID of the KVDB to list KVDB entries from

skip

skip number of elements to skip from result

limit

limit of elements to return for query

sortOrder

order of elements in result ("asc" for ascending, "desc" for descending)

lastId

ID of the element from which query results should start

queryAsJson

stringified JSON object with a custom field to filter result

sortBy

field by elements are sorted in result

Throws

thrown when instance is closed.

thrown when method encounters an exception.

thrown when method encounters an unknown exception.