Struct ruma_common::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) -> Self

Create a RoomMessageEventContent with the given MessageType.

source

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

A constructor to create a plain text message.

source

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

A constructor to create an html message.

source

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

Available on crate feature markdown only.

A constructor to create a markdown message.

source

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

A constructor to create a plain text notice.

source

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

A constructor to create an html notice.

source

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

Available on crate feature markdown only.

A constructor to create a markdown notice.

source

pub fn make_reply_to(self, original_message: &OriginalRoomMessageEvent) -> Self

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: &OriginalRoomMessageEvent
) -> Self

👎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: &OriginalRoomMessageEvent
) -> Self

👎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: &OriginalRoomMessageEvent
) -> Self

👎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: &OriginalRoomMessageEvent
) -> Self

👎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: &OriginalRoomMessageEvent,
    forward_thread: ForwardThread
) -> Self

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: &OriginalRoomMessageEvent,
    is_reply: ReplyInThread
) -> Self

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