Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMessageBuilder

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.

Hierarchy

  • IMessageBuilder

Index

Properties

kind

kind: MESSAGE

Methods

addAttachment

addBlocks

getAttachments

getAvatarUrl

  • getAvatarUrl(): string

getBlocks

getEditor

getEmojiAvatar

  • getEmojiAvatar(): string

getGroupable

  • getGroupable(): boolean

getMessage

getParseUrls

  • getParseUrls(): boolean

getRoom

getSender

getText

  • getText(): string

getThreadId

  • getThreadId(): string
  • 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 IMessageRead.getById() method

    Returns string

getUsernameAlias

  • getUsernameAlias(): string

removeAttachment

replaceAttachment

setAttachments

setAvatarUrl

setBlocks

setData

setEditor

setEmojiAvatar

setGroupable

setParseUrls

  • 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.

    Parameters

    • parseUrls: boolean

      whether URLs should be parsed in this message

    Returns IMessageBuilder

setRoom

setSender

setText

setThreadId

setUsernameAlias

Generated using TypeDoc