forked from GitHub-Mirror/riotX-android
64 lines
1.9 KiB
Kotlin
64 lines
1.9 KiB
Kotlin
/*
|
|
* 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.read
|
|
|
|
import androidx.lifecycle.LiveData
|
|
import im.vector.matrix.android.api.MatrixCallback
|
|
import im.vector.matrix.android.api.session.room.model.ReadReceipt
|
|
|
|
/**
|
|
* This interface defines methods to handle read receipts and read marker in a room. It's implemented at the room level.
|
|
*/
|
|
interface ReadService {
|
|
|
|
/**
|
|
* Force the read marker to be set on the latest event.
|
|
*/
|
|
fun markAllAsRead(callback: MatrixCallback<Void>)
|
|
|
|
/**
|
|
* Set the read receipt on the event with provided eventId.
|
|
*/
|
|
fun setReadReceipt(eventId: String, callback: MatrixCallback<Void>)
|
|
|
|
/**
|
|
* Set the read marker on the event with provided eventId.
|
|
*/
|
|
fun setReadMarker(fullyReadEventId: String, callback: MatrixCallback<Void>)
|
|
|
|
/**
|
|
* * @return the current list of read receipt as [LiveData]
|
|
*/
|
|
fun readReceipts(): LiveData<List<ReadReceipt>>
|
|
|
|
/**
|
|
* @param eventId to look for receipts.
|
|
* * @return the list of receipts associated with the eventId
|
|
*/
|
|
fun readReceipts(eventId: String): List<ReadReceipt>
|
|
|
|
/**
|
|
* A listener defined at the room level to listen for some read events.
|
|
*/
|
|
interface Listener {
|
|
/**
|
|
* Called when read receipts are updated in this room.
|
|
*/
|
|
fun onReadReceiptsUpdated()
|
|
}
|
|
|
|
} |