matrix-sdk-android/org.matrix.android.sdk.api.session.room.model/RoomSummary

RoomSummary

data class RoomSummary(val roomId: String, val displayName: String = "", val name: String = "", val topic: String = "", val avatarUrl: String = "", val canonicalAlias: String? = null, val aliases: List<String> = emptyList(), val joinRules: RoomJoinRules? = null, val isDirect: Boolean = false, val directUserId: String? = null, val directUserPresence: UserPresence? = null, val joinedMembersCount: Int? = 0, val invitedMembersCount: Int? = 0, val latestPreviewableEvent: TimelineEvent? = null, val otherMemberIds: List<String> = emptyList(), val notificationCount: Int = 0, val highlightCount: Int = 0, val threadNotificationCount: Int = 0, val threadHighlightCount: Int = 0, val hasUnreadMessages: Boolean = false, val tags: List<RoomTag> = emptyList(), val membership: Membership = Membership.NONE, val versioningState: VersioningState = VersioningState.NONE, val readMarkerId: String? = null, val userDrafts: List<UserDraft> = emptyList(), val isEncrypted: Boolean, val encryptionEventTs: Long?, val typingUsers: List<SenderInfo>, val inviterId: String? = null, val breadcrumbsIndex: Int = NOT_IN_BREADCRUMBS, val roomEncryptionTrustLevel: RoomEncryptionTrustLevel? = null, val hasFailedSending: Boolean = false, val roomType: String? = null, val spaceParents: List<SpaceParentInfo>? = null, val spaceChildren: List<SpaceChildInfo>? = null, val directParentNames: List<String> = emptyList(), val flattenParentIds: List<String> = emptyList(), val roomEncryptionAlgorithm: RoomEncryptionAlgorithm? = null)

This class holds some data of a room. It can be retrieved by org.matrix.android.sdk.api.session.room.Room and org.matrix.android.sdk.api.session.room.RoomService

Constructors

RoomSummary

constructor(roomId: String, displayName: String = "", name: String = "", topic: String = "", avatarUrl: String = "", canonicalAlias: String? = null, aliases: List<String> = emptyList(), joinRules: RoomJoinRules? = null, isDirect: Boolean = false, directUserId: String? = null, directUserPresence: UserPresence? = null, joinedMembersCount: Int? = 0, invitedMembersCount: Int? = 0, latestPreviewableEvent: TimelineEvent? = null, otherMemberIds: List<String> = emptyList(), notificationCount: Int = 0, highlightCount: Int = 0, threadNotificationCount: Int = 0, threadHighlightCount: Int = 0, hasUnreadMessages: Boolean = false, tags: List<RoomTag> = emptyList(), membership: Membership = Membership.NONE, versioningState: VersioningState = VersioningState.NONE, readMarkerId: String? = null, userDrafts: List<UserDraft> = emptyList(), isEncrypted: Boolean, encryptionEventTs: Long?, typingUsers: List<SenderInfo>, inviterId: String? = null, breadcrumbsIndex: Int = NOT_IN_BREADCRUMBS, roomEncryptionTrustLevel: RoomEncryptionTrustLevel? = null, hasFailedSending: Boolean = false, roomType: String? = null, spaceParents: List<SpaceParentInfo>? = null, spaceChildren: List<SpaceChildInfo>? = null, directParentNames: List<String> = emptyList(), flattenParentIds: List<String> = emptyList(), roomEncryptionAlgorithm: RoomEncryptionAlgorithm? = null)

Types

Companion

object Companion

Functions

hasTag

fun hasTag(tag: String): Boolean

Test if the room has the provided tag.

toEveryoneInRoomMatrixItem

fun RoomSummary.toEveryoneInRoomMatrixItem(): MatrixItem.EveryoneInRoomItem

toMatrixItem

fun RoomSummary.toMatrixItem(): MatrixItem

toRoomAliasMatrixItem

fun RoomSummary.toRoomAliasMatrixItem(): MatrixItem.RoomAliasItem

Properties

aliases

val aliases: List<String>

The list of all the aliases of this room. Content of the live state event m.room.aliases.

avatarUrl

val avatarUrl: String

The value of the live state event m.room.avatar.

breadcrumbsIndex

val breadcrumbsIndex: Int

Breadcrumb index, util to sort rooms by last seen.

canonicalAlias

val canonicalAlias: String? = null

The value of the live state event m.room.canonical_alias.

canStartCall

val canStartCall: Boolean

True if a 1-1 call can be started, i.e. the room has exactly 2 joined members.

directParentNames

val directParentNames: List<String>

The names of the room's direct space parents if any.

directUserId

val directUserId: String? = null

If isDirect is true, this is the id of the first other member of this room.

directUserPresence

val directUserPresence: UserPresence? = null

If isDirect is true, this it the presence of the first other member of this room.

displayName

val displayName: String

Computed display name. The value of the state event m.room.name if not empty, else can be the value returned by org.matrix.android.sdk.api.RoomDisplayNameFallbackProvider.

encryptionEventTs

val encryptionEventTs: Long?

Timestamp of the m.room.encryption state event.

flattenParentIds

val flattenParentIds: List<String>

List of all the space parent Ids.

hasFailedSending

val hasFailedSending: Boolean = false

True if a message has not been sent in this room.

hasNewMessages

val hasNewMessages: Boolean

True if notificationCount is not 0.