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

PublicRoomsParams

@JsonClass(generateAdapter = true)
data class PublicRoomsParams(@Json(name = "limit") val limit: Int? = null, @Json(name = "since") val since: String? = null, @Json(name = "filter") val filter: PublicRoomsFilter? = null, @Json(name = "include_all_networks") val includeAllNetworks: Boolean = false, @Json(name = "third_party_instance_id") val thirdPartyInstanceId: String? = null)

Class to pass parameters to get the public rooms list.

Constructors

Link copied to clipboard
constructor(@Json(name = "limit") limit: Int? = null, @Json(name = "since") since: String? = null, @Json(name = "filter") filter: PublicRoomsFilter? = null, @Json(name = "include_all_networks") includeAllNetworks: Boolean = false, @Json(name = "third_party_instance_id") thirdPartyInstanceId: String? = null)

Properties

Link copied to clipboard
val filter: PublicRoomsFilter? = null

Filter to apply to the results.

Link copied to clipboard
val includeAllNetworks: Boolean = false

Whether or not to include all known networks/protocols from application services on the homeserver. Defaults to false.

Link copied to clipboard
val limit: Int? = null

Limit the number of results returned.

Link copied to clipboard
val since: String? = null

A pagination token from a previous request, allowing clients to get the next (or previous) batch of rooms. The direction of pagination is specified solely by which token is supplied, rather than via an explicit flag.

Link copied to clipboard
val thirdPartyInstanceId: String? = null

The specific third party network/protocol to request from the homeserver. Can only be used if include_all_networks is false.