Interface for building out a message. Please note, that a room and sender must be associated otherwise you will NOT be able to successfully save the message object.
Adds a block collection to the message's own collection
Adds a custom field to the message. Note: This key can not already exist or it will throw an error. Note: The key must not contain a period in it, an error will be thrown.
the name of the custom field
the value of this custom field
Gets the attachments array for the message
Gets the url used for the avatar.
Gets the block collection of the message
Gets the user who edited the message
Gets the emoji used for the avatar.
Gets whether this message can group with others.
Gets the resulting message that has been built up to the point of calling it.
Note: This will error out if the Room has not been defined.
Gets whether this message should have its URLs parsed
Gets the room where this message was sent to.
Gets the User which sent the message.
Gets the message text.
Retrieves the threadId to which this message belongs, if any.
If you would like to retrieve the actual message that
the thread originated from, you can use the
Gets the display text of the sender's username that is visible.
Removes an attachment at the given position (index). If there is no attachment at that position, there will be an error thrown.
the index of the attachment to remove
Sets the url which to display for the avatar, this overwrites the current avatar whether it be the user's or an emoji one.
image url to use as the avatar
Sets the block collection of the message
Sets the emoji to use for the avatar, this overwrites the current avatar whether it be the user's or the avatar url provided.
the emoji code
Sets whether this message can group with others. This is desirable if you want to avoid confusion with other integrations.
whether this message can group with others
Sets whether this message should have any URLs in the text parsed by Rocket.Chat and get the details added to the message's attachments.
whether URLs should be parsed in this message
Sets the text of the message.
the actual text
Sets the thread to which this message belongs, if any.
The id of the thread
Sets the display text of the sender's username that is visible.
the username alias to display
Generated using TypeDoc