IMessageBuilder | Rocket.Chat Apps TypeScript Definition

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

addAttachment(attachment: IMessageAttachment): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:130
Adds one attachment to the message's list of attachments, this will not overwrite any existing ones but just adds.

Parameters
- attachment: IMessageAttachment
  
  the attachment to add
Returns IMessageBuilder

addBlocks

addBlocks(blocks: BlockBuilder | (IBlock | PlainText | Markdown | Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }> | PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>)[]; type: "actions" }> | LayoutBlockish<{ render: readonly (PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ type: "button"; text: PlainText; url?: string; value?: string; style?: "primary" | "danger"; }> | Actionable<{ type: "channels_select"; }> | ... 9 more ... | Actionable<...>)[]; type: "actions" }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]; type: "conditional"; when?: { engine?: readonly ("rocket.chat" | "livechat")[] } }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:212
Adds a block collection to the message's own collection

Parameters
- blocks: BlockBuilder | (IBlock | PlainText | Markdown | Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }> | PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>)[]; type: "actions" }> | LayoutBlockish<{ render: readonly (PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ type: "button"; text: PlainText; url?: string; value?: string; style?: "primary" | "danger"; }> | Actionable<{ type: "channels_select"; }> | ... 9 more ... | Actionable<...>)[]; type: "actions" }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]; type: "conditional"; when?: { engine?: readonly ("rocket.chat" | "livechat")[] } }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]
Returns IMessageBuilder

addCustomField

addCustomField(key: string, value: any): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:234
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.

Parameters
- key: string
  
  the name of the custom field
- value: any
  
  the value of this custom field
Returns IMessageBuilder

getAttachments

getAttachments(): IMessageAttachment[]

- Defined in src/definition/accessors/IMessageBuilder.ts:142
Gets the attachments array for the message

Returns IMessageAttachment[]

getAvatarUrl

getAvatarUrl(): string

- Defined in src/definition/accessors/IMessageBuilder.ts:110
Gets the url used for the avatar.

Returns string

getBlocks

getBlocks(): (IBlock | PlainText | Markdown | Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }> | PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>)[]; type: "actions" }> | LayoutBlockish<{ render: readonly (PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ type: "button"; text: PlainText; url?: string; value?: string; style?: "primary" | "danger"; }> | Actionable<{ type: "channels_select"; }> | ... 9 more ... | Actionable<...>)[]; type: "actions" }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]; type: "conditional"; when?: { engine?: readonly ("rocket.chat" | "livechat")[] } }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]

- Defined in src/definition/accessors/IMessageBuilder.ts:224
Gets the block collection of the message

Returns (IBlock | PlainText | Markdown | Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }> | PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>)[]; type: "actions" }> | LayoutBlockish<{ render: readonly (PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ type: "button"; text: PlainText; url?: string; value?: string; style?: "primary" | "danger"; }> | Actionable<{ type: "channels_select"; }> | ... 9 more ... | Actionable<...>)[]; type: "actions" }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]; type: "conditional"; when?: { engine?: readonly ("rocket.chat" | "livechat")[] } }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]

getEditor

getEditor(): IUser

- Defined in src/definition/accessors/IMessageBuilder.ts:172
Gets the user who edited the message

Returns IUser

getEmojiAvatar

getEmojiAvatar(): string

- Defined in src/definition/accessors/IMessageBuilder.ts:97
Gets the emoji used for the avatar.

Returns string

getGroupable

getGroupable(): boolean

- Defined in src/definition/accessors/IMessageBuilder.ts:185
Gets whether this message can group with others.

Returns boolean

getMessage

getMessage(): IMessage

- Defined in src/definition/accessors/IMessageBuilder.ts:206
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.

Returns IMessage

getParseUrls

getParseUrls(): boolean

- Defined in src/definition/accessors/IMessageBuilder.ts:199
Gets whether this message should have its URLs parsed

Returns boolean

getRoom

getRoom(): IRoom

- Defined in src/definition/accessors/IMessageBuilder.ts:60
Gets the room where this message was sent to.

Returns IRoom

getSender

getSender(): IUser

- Defined in src/definition/accessors/IMessageBuilder.ts:72
Gets the User which sent the message.

Returns IUser

getText

getText(): string

- Defined in src/definition/accessors/IMessageBuilder.ts:84
Gets the message text.

Returns string

getThreadId

getThreadId(): string

- Defined in src/definition/accessors/IMessageBuilder.ts:48
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

- Defined in src/definition/accessors/IMessageBuilder.ts:122
Gets the display text of the sender's username that is visible.

Returns string

removeAttachment

removeAttachment(position: number): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:159
Removes an attachment at the given position (index). If there is no attachment at that position, there will be an error thrown.

Parameters
- position: number
  
  the index of the attachment to remove
Returns IMessageBuilder

replaceAttachment

replaceAttachment(position: number, attachment: IMessageAttachment): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:151
Replaces an attachment at the given position (index). If there is no attachment at that position, there will be an error thrown.

Parameters
- position: number
  
  the index of the attachment to replace
- attachment: IMessageAttachment
  
  the attachment to replace with
Returns IMessageBuilder

setAttachments

setAttachments(attachments: IMessageAttachment[]): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:137
Sets the attachments for the message, replacing and destroying all of the current attachments.

Parameters
- attachments: IMessageAttachment[]
  
  array of the attachments
Returns IMessageBuilder

setAvatarUrl

setAvatarUrl(avatarUrl: string): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:105
Sets the url which to display for the avatar, this overwrites the current avatar whether it be the user's or an emoji one.

Parameters
- avatarUrl: string
  
  image url to use as the avatar
Returns IMessageBuilder

setBlocks

setBlocks(blocks: BlockBuilder | (IBlock | PlainText | Markdown | Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }> | PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>)[]; type: "actions" }> | LayoutBlockish<{ render: readonly (PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ type: "button"; text: PlainText; url?: string; value?: string; style?: "primary" | "danger"; }> | Actionable<{ type: "channels_select"; }> | ... 9 more ... | Actionable<...>)[]; type: "actions" }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]; type: "conditional"; when?: { engine?: readonly ("rocket.chat" | "livechat")[] } }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:219
Sets the block collection of the message

Parameters
- blocks: BlockBuilder | (IBlock | PlainText | Markdown | Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }> | PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>)[]; type: "actions" }> | LayoutBlockish<{ render: readonly (PreviewBlockBase | PreviewBlockWithThumb | PreviewBlockWithPreview | LayoutBlockish<{ elements: readonly (Actionable<{ type: "button"; text: PlainText; url?: string; value?: string; style?: "primary" | "danger"; }> | Actionable<{ type: "channels_select"; }> | ... 9 more ... | Actionable<...>)[]; type: "actions" }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]; type: "conditional"; when?: { engine?: readonly ("rocket.chat" | "livechat")[] } }> | LayoutBlockish<{ elements: readonly ContextBlockElements[]; type: "context" }> | LayoutBlockish<{ type: "divider" }> | LayoutBlockish<{ altText: string; imageUrl: string; title?: PlainText; type: "image" }> | LayoutBlockish<{ element: Actionable<{ type: "channels_select" }> | Actionable<{ type: "conversations_select" }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | Actionable<{ initialValue?: number; maxValue?: number; minValue?: number; postLabel?: PlainText; preLabel?: PlainText; type: "linear_scale" }> | Actionable<{ type: "multi_channels_select" }> | Actionable<{ type: "multi_conversations_select" }> | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ type: "multi_users_select" }> | Actionable<{ initialValue?: string; maxLength?: number; minLength?: number; multiline?: boolean; placeholder?: PlainText; type: "plain_text_input" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }> | Actionable<{ type: "users_select" }>; hint?: PlainText; label: PlainText; optional?: boolean; type: "input" }> | LayoutBlockish<{ accessory?: Actionable<{ style?: "primary" | "danger"; text: PlainText; type: "button"; url?: string; value?: string }> | Actionable<{ initialDate?: string; placeholder?: TextObject; type: "datepicker" }> | ImageElement | Actionable<{ initialOption?: Option[]; initialValue?: string[]; maxSelectItems?: number; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "multi_static_select" }> | Actionable<{ options: readonly Option[]; type: "overflow" }> | Actionable<{ initialOption?: Option; initialValue?: string; optionGroups?: readonly OptionGroup[]; options: readonly Option[]; placeholder: TextObject; type: "static_select" }>; fields?: readonly TextObject[]; text?: TextObject; type: "section" }> | LayoutBlockish<{ callId: string; type: "video_conf" }>)[]
Returns IMessageBuilder

setData

setData(message: IMessage): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:22
Provides a convenient way to set the data for the message. Note: Providing an "id" field here will be ignored.

Parameters
- message: IMessage
  
  the message data to set
Returns IMessageBuilder

setEditor

setEditor(user: IUser): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:167
Sets the user who is editing this message. This is required if you are modifying an existing message.

Parameters
- user: IUser
  
  the editor
Returns IMessageBuilder

setEmojiAvatar

setEmojiAvatar(emoji: string): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:92
Sets the emoji to use for the avatar, this overwrites the current avatar whether it be the user's or the avatar url provided.

Parameters
- emoji: string
  
  the emoji code
Returns IMessageBuilder

setGroupable

setGroupable(groupable: boolean): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:180
Sets whether this message can group with others. This is desirable if you want to avoid confusion with other integrations.

Parameters
- groupable: boolean
  
  whether this message can group with others
Returns IMessageBuilder

setParseUrls

setParseUrls(parseUrls: boolean): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:194
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

setRoom(room: IRoom): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:55
Sets the room where this message should be sent to.

Parameters
- room: IRoom
  
  the room where to send
Returns IMessageBuilder

setSender

setSender(sender: IUser): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:67
Sets the sender of this message.

Parameters
- sender: IUser
  
  the user sending the message
Returns IMessageBuilder

setText

setText(text: string): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:79
Sets the text of the message.

Parameters
- text: string
  
  the actual text
Returns IMessageBuilder

setThreadId

setThreadId(threadId: string): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:38
Sets the thread to which this message belongs, if any.

Parameters
- threadId: string
  
  The id of the thread
Returns IMessageBuilder

setUpdateData

setUpdateData(message: IMessage, editor: IUser): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:31
Provides a convenient way to set the data for the message keeping the "id" field so as to update the message later.

Parameters
- message: IMessage
  
  the message data to set
- editor: IUser
  
  the user who edited the updated message
Returns IMessageBuilder

setUsernameAlias

setUsernameAlias(alias: string): IMessageBuilder

- Defined in src/definition/accessors/IMessageBuilder.ts:117
Sets the display text of the sender's username that is visible.

Parameters
- alias: string
  
  the username alias to display
Returns IMessageBuilder

Hierarchy

Index

Properties

Methods

Properties

kind

Methods

addAttachment

Parameters

attachment: IMessageAttachment

Returns IMessageBuilder

addBlocks

Parameters

Returns IMessageBuilder

addCustomField

Parameters

key: string

value: any

Returns IMessageBuilder

getAttachments

Returns IMessageAttachment[]

getAvatarUrl

Returns string

getBlocks

getEditor

Returns IUser

getEmojiAvatar

Returns string

getGroupable

Returns boolean

getMessage

Returns IMessage

getParseUrls

Returns boolean

getRoom

Returns IRoom

getSender

Returns IUser

getText

Returns string

getThreadId

Returns string

getUsernameAlias

Returns string

removeAttachment

Parameters

position: number

Returns IMessageBuilder

replaceAttachment

Parameters

position: number

attachment: IMessageAttachment

Returns IMessageBuilder

setAttachments

Parameters

attachments: IMessageAttachment[]

Returns IMessageBuilder

setAvatarUrl

Parameters

avatarUrl: string

Returns IMessageBuilder

setBlocks

Parameters

Returns IMessageBuilder

setData

Parameters

message: IMessage

Returns IMessageBuilder

setEditor

Parameters

user: IUser

Returns IMessageBuilder

setEmojiAvatar

Parameters

emoji: string

Returns IMessageBuilder

setGroupable

Parameters

groupable: boolean

Returns IMessageBuilder