matrix-sdk-android/org.matrix.android.sdk.api.session.room.model.roomdirectory/PublicRoomsResponse

PublicRoomsResponse

@JsonClass(generateAdapter = true)

data class PublicRoomsResponse( @Json(name = "next_batch") val nextBatch: String? = null, @Json(name = "prev_batch") val prevBatch: String? = null, @Json(name = "chunk") val chunk: List<PublicRoom>? = null, @Json(name = "total_room_count_estimate") val totalRoomCountEstimate: Int? = null)

Class representing the public rooms request response.

Constructors

PublicRoomsResponse

fun PublicRoomsResponse( @Json(name = "next_batch") nextBatch: String? = null, @Json(name = "prev_batch") prevBatch: String? = null, @Json(name = "chunk") chunk: List<PublicRoom>? = null, @Json(name = "total_room_count_estimate") totalRoomCountEstimate: Int? = null)

Properties

chunk

val chunk: List<PublicRoom>? = null

A paginated chunk of public rooms.

nextBatch

val nextBatch: String? = null

A pagination token for the response. The absence of this token means there are no more results to fetch and the client should stop paginating.

prevBatch

val prevBatch: String? = null

A pagination token that allows fetching previous results. The absence of this token means there are no results before this batch, i.e. this is the first batch.

totalRoomCountEstimate

val totalRoomCountEstimate: Int? = null

An estimate on the total number of public rooms, if the server has an estimate.