privmx-endpoint/com.simplito.kotlin.privmx_endpoint.modules.core/Connection/listContextUsers

listContextUsers

expect fun listContextUsers(contextId: String, skip: Long, limit: Long, sortOrder: String = "desc", lastId: String? = null, queryAsJson: String? = null, sortBy: String? = null): PagingList<UserInfo>

Gets a list of users with their status and the last status change.

Return

List of users with their status and the last status change

Parameters

contextId

ID of the Context

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 name to sort elements by

Throws

thrown when instance is not connected.

thrown when method encounters an exception.

thrown when method encounters an unknown exception.

actual fun listContextUsers(contextId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?, queryAsJson: String?, sortBy: String?): PagingList<UserInfo>

Gets a list of users with their status and the last status change.

Return

List of users with their status and the last status change

Parameters

contextId

ID of the Context

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 name to sort elements by

Throws

thrown when instance is not connected.

thrown when method encounters an exception.

thrown when method encounters an unknown exception.

@JvmOverloads
actual external fun listContextUsers(contextId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?, queryAsJson: String?, sortBy: String?): PagingList<UserInfo>

Gets a list of users with their status and the last status change.

Return

List of users with their status and the last status change

Parameters

contextId

ID of the Context

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 name to sort elements by

Throws

thrown when instance is not connected.

thrown when method encounters an exception.

thrown when method encounters an unknown exception.