mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-07 07:27:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

sdk: Improve documentation of send, send_raw

Browse Source
This commit is contained in:
Jonas Platte
2023-10-31 10:20:00 +01:00
committed by Jonas Platte
parent a00c0c1c02
commit 61eb9cea8c
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
crates/matrix-sdk/src/room/mod.rs
View File

@@ -1281,15 +1281,16 @@ impl Room {
}
}
/// Send a room message to this room.
/// Send a message-like event to this room.
///
/// Returns the parsed response from the server.
///
/// If the encryption feature is enabled this method will transparently
/// encrypt the room message if this room is encrypted.
/// encrypt the event if this room is encrypted (except for `m.reaction`
/// events, which are never encrypted).
///
/// **Note**: If you just want to send a custom JSON payload to a room, you
/// can use the [`send_raw()`][Self::send_raw] method for that.
/// **Note**: If you just want to send an event with custom JSON content to
/// a room, you can use the [`send_raw()`][Self::send_raw] method for that.
///
/// If you want to set a transaction ID for the event, use
/// [`.with_transaction_id()`][SendMessageLikeEvent::with_transaction_id]
@@ -1387,12 +1388,13 @@ impl Room {
Ok(())
}
/// Send a room message to this room from a json `Value`.
/// Send a message-like event with custom JSON content to this room.
///
/// Returns the parsed response from the server.
///
/// If the encryption feature is enabled this method will transparently
/// encrypt the room message if this room is encrypted.
/// encrypt the event if this room is encrypted (except for `m.reaction`
/// events, which are never encrypted).
///
/// This method is equivalent to the [`send()`][Self::send] method but
/// allows sending custom JSON payloads, e.g. constructed using the