Skip to content

docs(sdk): Improve read receipt/marker explanation #1491

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

Merged
merged 1 commit into from
Feb 13, 2023
Merged

docs(sdk): Improve read receipt/marker explanation #1491

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
17 changes: 12 additions & 5 deletions crates/matrix-sdk/src/room/joined.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,8 +229,12 @@ impl Joined {
Ok(())
}

/// Send a request to notify this room that the user has read specific
/// event.
/// Send a request to set a read receipt, notifying this room that the user
/// has read a specific event and *some* - but maybe not all - events before
/// it.
///
/// Use [`read_marker`][Self::read_marker] to indicate that the user has
/// read a specific event and *every* message before it.
///
/// # Arguments
///
Expand All @@ -247,12 +251,15 @@ impl Joined {
Ok(())
}

/// Send a request to notify this room that the user has read up to specific
/// event.
/// Send a request to set a read marker, notifying this room that the user
/// has read a specific event and *all* events before it.
///
/// Use [`read_receipt`][Self::read_receipt] to indicate that the user has
/// read a specific event and *some* - but maybe not all - events before it.
///
/// # Arguments
///
/// * fully_read - The `EventId` of the event the user has read to.
/// * fully_read - The `EventId` of the event to set the read marker on.
///
/// * read_receipt - An `EventId` to specify the event to set the read
/// receipt on.
Expand Down