matrix-sdk-android/org.matrix.android.sdk.api.session.room/RoomSummaryQueryParams

RoomSummaryQueryParams

data class RoomSummaryQueryParams(val roomId: QueryStringValue, val displayName: QueryStringValue, val canonicalAlias: QueryStringValue, val memberships: List<Membership>, val roomCategoryFilter: RoomCategoryFilter?, val roomTagQueryFilter: RoomTagQueryFilter?, val excludeType: List<String?>?, val includeType: List<String?>?, val spaceFilter: SpaceFilter)

This class can be used to filter room summaries to use with RoomService. It provides a Builder. roomSummaryQueryParams and spaceSummaryQueryParams can also be used to build an instance of this class.

Constructors

constructor(roomId: QueryStringValue, displayName: QueryStringValue, canonicalAlias: QueryStringValue, memberships: List<Membership>, roomCategoryFilter: RoomCategoryFilter?, roomTagQueryFilter: RoomTagQueryFilter?, excludeType: List<String?>?, includeType: List<String?>?, spaceFilter: SpaceFilter)

Types

Builder

class Builder

Builder for RoomSummaryQueryParams. roomSummaryQueryParams and spaceSummaryQueryParams can also be used to build an instance of RoomSummaryQueryParams.

Properties

canonicalAlias

val canonicalAlias: QueryStringValue

Query for the canonical alias of the room.

displayName

val displayName: QueryStringValue

Query for the displayName of the room. The display name can be the value of the state event, or a value returned by org.matrix.android.sdk.api.RoomDisplayNameFallbackProvider.

excludeType