privmx-endpoint/com.simplito.kotlin.privmx_endpoint.modules.store/StoreApi/listStores

listStores

expect fun listStores(contextId: String, skip: Long, limit: Long, sortOrder: String = "desc", lastId: String? = null): PagingList<Store>

Gets a list of Stores in given Context.

Return

list of Stores

Parameters

contextId

ID of the Context to get the Stores 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

Throws

thrown when instance is closed

thrown when method encounters an exception

thrown when method encounters an unknown exception

actual fun listStores(contextId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?): PagingList<Store>

Gets a list of Stores in given Context.

Return

list of Stores

Parameters

contextId

ID of the Context to get the Stores 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

Throws

thrown when instance is closed

thrown when method encounters an exception

thrown when method encounters an unknown exception

@JvmOverloads
actual external fun listStores(contextId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?): PagingList<Store>

Gets a list of Stores in given Context.

Return

list of Stores

Parameters

contextId

ID of the Context to get the Stores 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

Throws

thrown when instance is closed

thrown when method encounters an exception

thrown when method encounters an unknown exception