2019-01-18 10:12:08 +00:00
|
|
|
/*
|
2019-01-25 13:04:59 +00:00
|
|
|
* Copyright 2019 New Vector Ltd
|
2019-01-18 10:12:08 +00:00
|
|
|
*
|
2019-01-25 13:04:59 +00:00
|
|
|
* 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
|
2019-01-18 10:12:08 +00:00
|
|
|
*
|
2019-01-25 13:04:59 +00:00
|
|
|
* 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.
|
2019-01-18 10:12:08 +00:00
|
|
|
*/
|
|
|
|
|
2018-10-17 16:21:09 +00:00
|
|
|
package im.vector.matrix.android.api.session.room
|
|
|
|
|
2019-01-16 18:25:43 +00:00
|
|
|
import androidx.lifecycle.LiveData
|
2019-01-31 19:40:32 +00:00
|
|
|
import im.vector.matrix.android.api.session.room.members.RoomMembersService
|
2018-10-29 13:57:36 +00:00
|
|
|
import im.vector.matrix.android.api.session.room.model.RoomSummary
|
2019-01-28 16:56:23 +00:00
|
|
|
import im.vector.matrix.android.api.session.room.read.ReadService
|
2019-01-18 15:26:17 +00:00
|
|
|
import im.vector.matrix.android.api.session.room.send.SendService
|
2019-01-07 18:38:36 +00:00
|
|
|
import im.vector.matrix.android.api.session.room.timeline.TimelineService
|
2018-10-19 12:26:13 +00:00
|
|
|
|
2019-01-18 15:26:17 +00:00
|
|
|
/**
|
|
|
|
* This interface defines methods to interact within a room.
|
|
|
|
*/
|
2019-01-31 19:40:32 +00:00
|
|
|
interface Room : TimelineService, SendService, ReadService, RoomMembersService {
|
2018-10-17 16:21:09 +00:00
|
|
|
|
2019-01-18 15:26:17 +00:00
|
|
|
/**
|
|
|
|
* The roomId of this room
|
|
|
|
*/
|
2018-10-17 16:21:09 +00:00
|
|
|
val roomId: String
|
|
|
|
|
2019-01-18 15:26:17 +00:00
|
|
|
/**
|
|
|
|
* A live [RoomSummary] associated with the room
|
2019-01-29 13:16:22 +00:00
|
|
|
* You can observe this summary to get dynamic data from this room.
|
2019-01-18 15:26:17 +00:00
|
|
|
*/
|
2018-10-29 13:57:36 +00:00
|
|
|
val roomSummary: LiveData<RoomSummary>
|
2018-10-23 16:25:28 +00:00
|
|
|
|
2019-02-01 11:38:33 +00:00
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-10-17 16:21:09 +00:00
|
|
|
}
|