BayernMessenger/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/Room.kt

/*
 * Copyright 2019 New Vector Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package im.vector.matrix.android.api.session.room

import androidx.lifecycle.LiveData
import im.vector.matrix.android.api.session.room.members.RoomMembersService
import im.vector.matrix.android.api.session.room.model.RoomSummary
import im.vector.matrix.android.api.session.room.read.ReadService
import im.vector.matrix.android.api.session.room.send.SendService
import im.vector.matrix.android.api.session.room.timeline.TimelineService

/**
 * This interface defines methods to interact within a room.
 */
interface Room : TimelineService, SendService, ReadService, RoomMembersService {

    /**
     * The roomId of this room
     */
    val roomId: String

    /**
     * A live [RoomSummary] associated with the room
     * You can observe this summary to get dynamic data from this room.
     */
    val roomSummary: LiveData<RoomSummary>

    /**
     * Add a listener to the room.
     * @param listener the listener to add.
     */
    fun addListener(listener: Listener)

    /**
     * Remove a listener from the room.
     * @param listener the listener to remove.
     */
    fun removeListener(listener: Listener)

    /**
     * A listener defined at the room level to listen for some events from the different room services.
     */
    interface Listener : ReadService.Listener {

        override fun onReadReceiptsUpdated() {
            // no-op
        }
    }

}