Skip to content

docs(timeline): clarify what mark_as_read actually does #5906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(timeline): clarify what mark_as_read actually does #5906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions bindings/matrix-sdk-ffi/src/timeline/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,12 +354,21 @@ impl Timeline {
Ok(())
}

/// Mark the room as read by trying to attach an *unthreaded* read receipt
/// to the latest room event.
/// Mark the timeline as read by attempting to send a read receipt on the
/// latest visible event.
///
/// This works even if the latest event belongs to a thread, as a threaded
/// reply also belongs to the unthreaded timeline. No threaded receipt
/// will be sent here (see also #3123).
/// The latest visible event is determined from the timeline's focus kind
/// and whether or not it hides threaded events. If no latest event can
/// be determined and the timeline is live, the room's unread marker is
/// unset instead.
///
/// # Arguments
///
/// * `receipt_type` - The type of receipt to send. When using
/// [`ReceiptType::FullyRead`], an unthreaded receipt will be sent. This
/// works even if the latest event belongs to a thread, as a threaded
/// reply also belongs to the unthreaded timeline. Otherwise the receipt
/// thread will be determined based on the timeline's focus kind.
pub async fn mark_as_read(&self, receipt_type: ReceiptType) -> Result<(), ClientError> {
self.inner.mark_as_read(receipt_type.into()).await?;
Ok(())
Expand Down
24 changes: 17 additions & 7 deletions crates/matrix-sdk-ui/src/timeline/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,16 +788,26 @@ impl Timeline {
Ok(())
}

/// Mark the room as read by sending an unthreaded read receipt on the
/// latest event, be it visible or not.
/// Mark the timeline as read by attempting to send a read receipt on the
/// latest visible event.
///
/// This works even if the latest event belongs to a thread, as a threaded
/// reply also belongs to the unthreaded timeline. No threaded receipt
/// will be sent here (see also #3123).
/// The latest visible event is determined from the timeline's focus kind
/// and whether or not it hides threaded events. If no latest event can
/// be determined and the timeline is live, the room's unread marker is
/// unset instead.
///
/// This also unsets the unread marker of the room if necessary.
/// # Arguments
///
/// Returns a boolean indicating if it sent the receipt or not.
/// * `receipt_type` - The type of receipt to send. When using
/// [`ReceiptType::FullyRead`], an unthreaded receipt will be sent. This
/// works even if the latest event belongs to a thread, as a threaded
/// reply also belongs to the unthreaded timeline. Otherwise the
/// [`ReceiptThread`] will be determined based on the timeline's focus
/// kind.
///
/// # Returns
///
/// A boolean indicating if the receipt was sent or not.
#[instrument(skip(self), fields(room_id = ?self.room().room_id()))]
pub async fn mark_as_read(&self, receipt_type: ReceiptType) -> Result<bool> {
if let Some(event_id) = self.controller.latest_event_id().await {
Expand Down
Loading