Struct ruma::events::room::message::RoomMessageEventContent

source · [−]

pub struct RoomMessageEventContent {
    pub msgtype: MessageType,
    pub relates_to: Option<Relation>,
}

Available on crate feature events only.

Expand description

The content of an m.room.message event.

This event is used when sending messages in a room.

Messages are not limited to be text.

Fields

msgtype: MessageType

A key which identifies the type of message being sent.

This also holds the specific content of each message.

relates_to: Option<Relation>

Information about related messages for rich replies.

Implementations

source

impl RoomMessageEventContent

source

pub fn new(msgtype: MessageType) -> RoomMessageEventContent

Create a RoomMessageEventContent with the given MessageType.

source

pub fn text_plain(body: impl Into<String>) -> RoomMessageEventContent

A constructor to create a plain text message.

source

pub fn text_html(
body: impl Into<String>,
html_body: impl Into<String>
) -> RoomMessageEventContent

A constructor to create an html message.

source

pub fn text_markdown(
body: impl AsRef<str> + Into<String>
) -> RoomMessageEventContent

Available on crate feature markdown only.

A constructor to create a markdown message.

source

pub fn notice_plain(body: impl Into<String>) -> RoomMessageEventContent

A constructor to create a plain text notice.

source

pub fn notice_html(
body: impl Into<String>,
html_body: impl Into<String>
) -> RoomMessageEventContent

A constructor to create an html notice.

source

pub fn notice_markdown(
body: impl AsRef<str> + Into<String>
) -> RoomMessageEventContent

Available on crate feature markdown only.

A constructor to create a markdown notice.

source

pub fn make_reply_to(
self,
original_message: &OriginalMessageLikeEvent<RoomMessageEventContent>
) -> RoomMessageEventContent

Turns self into a reply to the given message.

Takes the body / formatted_body (if any) in self for the main text and prepends a quoted version of original_message. Also sets the in_reply_to field inside relates_to.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the sanitize feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

Panics

Panics if self has a formatted_body with a format other than HTML.

source

pub fn text_reply_plain(
reply: impl Display,
original_message: &OriginalMessageLikeEvent<RoomMessageEventContent>
) -> RoomMessageEventContent

👎Deprecated:

use Self::text_plain(reply).make_reply_to(original_message) instead

Creates a plain text reply to a message.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the sanitize feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

source

pub fn text_reply_html(
 reply: impl Display,
 html_reply: impl Display,
 original_message: &OriginalMessageLikeEvent<RoomMessageEventContent>
) -> RoomMessageEventContent

👎Deprecated:

use Self::text_html(reply, html_reply).make_reply_to(original_message) instead

Creates a html text reply to a message.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the sanitize feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

source

pub fn notice_reply_plain(
reply: impl Display,
original_message: &OriginalMessageLikeEvent<RoomMessageEventContent>
) -> RoomMessageEventContent

👎Deprecated:

use Self::notice_plain(reply).make_reply_to(original_message) instead

Creates a plain text notice reply to a message.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the sanitize feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

source

pub fn notice_reply_html(
 reply: impl Display,
 html_reply: impl Display,
 original_message: &OriginalMessageLikeEvent<RoomMessageEventContent>
) -> RoomMessageEventContent

👎Deprecated:

use Self::notice_html(reply, html_reply).make_reply_to(original_message) instead

Creates a html text notice reply to a message.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the sanitize feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

source

pub fn reply(
 message: MessageType,
 original_message: &OriginalMessageLikeEvent<RoomMessageEventContent>,
 forward_thread: ForwardThread
) -> RoomMessageEventContent

Available on crate feature unstable-msc3440 only.

Create a new reply with the given message and optionally forwards the Relation::Thread.

If message is a text, an emote or a notice message, it is modified to include the rich reply fallback.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the sanitize feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

source

pub fn for_thread(
 message: MessageType,
 previous_message: &OriginalMessageLikeEvent<RoomMessageEventContent>,
 is_reply: ReplyInThread
) -> RoomMessageEventContent

Available on crate feature unstable-msc3440 only.

Create a new message for a thread that is optionally a reply.

Looks for a Relation::Thread in previous_message. If it exists, a message for the same thread is created. If it doesn’t, a new thread with previous_message as the root is created.

If message is a text, an emote or a notice message, and this is a reply in the thread, it is modified to include the rich reply fallback.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the sanitize feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

source

pub fn msgtype(&self) -> &str

Returns a reference to the msgtype string.

If you want to access the message type-specific data rather than the message type itself, use the msgtype field, not this method.

source

pub fn body(&self) -> &str

Return a reference to the message body.

source

pub fn sanitize(
    &mut self,
    mode: HtmlSanitizerMode,
    remove_reply_fallback: RemoveReplyFallback
)

Available on crate feature unstable-sanitize only.

Sanitize this message.

If this message contains HTML, this removes the tags and attributes that are not listed in the Matrix specification.

It can also optionally remove the rich reply fallback from the plain text and HTML message.

This method is only effective on text, notice and emote messages.

Trait Implementations

source

impl Clone for RoomMessageEventContent

source

fn clone(&self) -> RoomMessageEventContent

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for RoomMessageEventContent

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for RoomMessageEventContent

source

fn deserialize<D>(
deserializer: D
) -> Result<RoomMessageEventContent, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl EventContent for RoomMessageEventContent

type EventType = MessageLikeEventType

The Rust enum for the event kind’s known types.

source

fn event_type(&self) -> <RoomMessageEventContent as EventContent>::EventType

Get the event’s type, like m.room.message.

source