Params

class Params

A class that provides configuration for RoomListQuery

Since

1.7.0

Constructors

Params
Link copied to clipboard
fun Params()

Functions

setCreatedByUserIds
Link copied to clipboard
fun setCreatedByUserIds(userIds: List<String>): RoomListQuery.Params

Filters query results to include rooms that were created by specified user IDs.

setLimit
Link copied to clipboard
fun setLimit(limit: Int): RoomListQuery.Params

Sets the number of rooms to be retrieved at once.

setRangeForCreatedAt
Link copied to clipboard
fun setRangeForCreatedAt(range: Range): RoomListQuery.Params

Filters query results to include rooms that were created between the specified range of time.

setRangeForCurrentParticipantCount
Link copied to clipboard
fun setRangeForCurrentParticipantCount(range: Range): RoomListQuery.Params

Filters query results to include rooms with the specified range of numbers for current participants.

setRoomIds
Link copied to clipboard
fun setRoomIds(roomIds: List<String>): RoomListQuery.Params

Filters query results to include rooms that match the specified room IDs.

setState
Link copied to clipboard
fun setState(state: RoomState): RoomListQuery.Params

Filters query results to include room with the specified room state.

setType
Link copied to clipboard
fun setType(type: RoomType): RoomListQuery.Params

Filters query results to include rooms with the specified room type.

Properties

createdAtRange
Link copied to clipboard
var createdAtRange: Range? = null
createdUserIds
Link copied to clipboard
var createdUserIds: List<String>
currentParticipantCountRange
Link copied to clipboard
var currentParticipantCountRange: Range? = null
limit
Link copied to clipboard
var limit: Int = 10
roomIds
Link copied to clipboard
var roomIds: List<String>
state
Link copied to clipboard
var state: RoomState? = null
type
Link copied to clipboard
var type: RoomType? = null