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

Room

interface Room

This interface defines methods to interact within a room.

Functions

Link copied to clipboard
abstract fun aliasService(): AliasService

Get the AliasService associated to this Room.

Link copied to clipboard
abstract fun asSpace(): Space?

Use this room as a Space, if the type is correct.

Link copied to clipboard
abstract fun draftService(): DraftService

Get the DraftService associated to this Room.

Link copied to clipboard
abstract fun getLocalRoomSummaryLive(): LiveData<Optional<LocalRoomSummary>>

A live LocalRoomSummary associated with the room. You can observe this summary to get dynamic data from this room.

Link copied to clipboard
abstract fun getRoomSummaryLive(): LiveData<Optional<RoomSummary>>

A live RoomSummary associated with the room. You can observe this summary to get dynamic data from this room.

Link copied to clipboard
fun Room.getStateEvent(eventType: String, stateKey: QueryStateEventValue): Event?

Get a StateEvent using the StateService of a Room.

Link copied to clipboard
fun Room.getTimelineEvent(eventId: String): TimelineEvent?

Get a TimelineEvent using the TimelineService of a Room.

Link copied to clipboard
abstract fun localRoomSummary(): LocalRoomSummary?

A current snapshot of LocalRoomSummary associated with the room.

Link copied to clipboard
abstract fun locationSharingService(): LocationSharingService

Get the LocationSharingService associated to this Room.

Link copied to clipboard
abstract fun membershipService(): MembershipService

Get the MembershipService associated to this Room.

Link copied to clipboard
abstract fun pollHistoryService(): PollHistoryService

Get the PollHistoryService associated to this Room.

Link copied to clipboard
abstract fun readService(): ReadService

Get the ReadService associated to this Room.

Link copied to clipboard
abstract fun relationService(): RelationService

Get the RelationService associated to this Room.

Link copied to clipboard
abstract fun reportingService(): ReportingService

Get the ReportingService associated to this Room.

Link copied to clipboard
abstract fun roomAccountDataService(): RoomAccountDataService

Get the RoomAccountDataService associated to this Room.

Link copied to clipboard
abstract fun roomCallService(): RoomCallService

Get the RoomCallService associated to this Room.

Link copied to clipboard
abstract fun roomCryptoService(): RoomCryptoService

Get the RoomCryptoService associated to this Room.

Link copied to clipboard
abstract fun roomPushRuleService(): RoomPushRuleService

Get the RoomPushRuleService associated to this Room.

Link copied to clipboard
abstract fun roomSummary(): RoomSummary?

A current snapshot of RoomSummary associated with the room.

Link copied to clipboard
abstract fun roomVersionService(): RoomVersionService

Get the RoomVersionService associated to this Room.

Link copied to clipboard
abstract fun sendService(): SendService

Get the SendService associated to this Room.

Link copied to clipboard
abstract fun stateService(): StateService

Get the StateService associated to this Room.

Link copied to clipboard
abstract fun tagsService(): TagsService

Get the TagsService associated to this Room.

Link copied to clipboard
abstract fun threadsLocalService(): ThreadsLocalService

Get the ThreadsLocalService associated to this Room.

Link copied to clipboard
abstract fun threadsService(): ThreadsService

Get the ThreadsService associated to this Room.

Link copied to clipboard
abstract fun timelineService(): TimelineService

Get the TimelineService associated to this Room.

Link copied to clipboard
abstract fun typingService(): TypingService

Get the TypingService associated to this Room.

Link copied to clipboard
abstract fun uploadsService(): UploadsService

Get the UploadsService associated to this Room.

Properties

Link copied to clipboard
Link copied to clipboard
abstract val roomId: String

The roomId of this room.