privmx-endpoint/com.simplito.kotlin.privmx_endpoint.modules.inbox/InboxApi/listInboxes

listInboxes

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

Gets a list of Inboxes in given Context.

Return

list of Inboxes

Parameters

contextId

ID of the Context to get Inboxes 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 method encounters an exception

thrown when method encounters an unknown exception

thrown when instance is closed

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

Gets a list of Inboxes in given Context.

Return

list of Inboxes

Parameters

contextId

ID of the Context to get Inboxes 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 method encounters an exception

thrown when method encounters an unknown exception

thrown when instance is closed

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

Gets a list of Inboxes in given Context.

Return

list of Inboxes

Parameters

contextId

ID of the Context to get Inboxes 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 method encounters an exception

thrown when method encounters an unknown exception

thrown when instance is closed