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

Properties

kind

Methods

addAttachment

addAttachment(attachment: IMessageAttachment): IMessageBuilder

- Defined in accessors/IModify.ts:291
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

getAttachments

getAttachments(): Array<IMessageAttachment>

- Defined in accessors/IModify.ts:303
Gets the attachments array for the message

Returns Array<IMessageAttachment>

getAvatarUrl

getAvatarUrl(): string

- Defined in accessors/IModify.ts:271
Gets the url used for the avatar.

Returns string

getEditor

getEditor(): IUser

- Defined in accessors/IModify.ts:333
Gets the user who edited the message

Returns IUser

getEmojiAvatar

getEmojiAvatar(): string

- Defined in accessors/IModify.ts:258
Gets the emoji used for the avatar.

Returns string

getMessage

getMessage(): IMessage

- Defined in accessors/IModify.ts:340
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

getRoom

getRoom(): IRoom

- Defined in accessors/IModify.ts:221
Gets the room where this message was sent to.

Returns IRoom

getSender

getSender(): IUser

- Defined in accessors/IModify.ts:233
Gets the User which sent the message.

Returns IUser

getText

getText(): string

- Defined in accessors/IModify.ts:245
Gets the message text.

Returns string

getUsernameAlias

getUsernameAlias(): string

- Defined in accessors/IModify.ts:283
Gets the display text of the sender's username that is visible.

Returns string

removeAttachment

removeAttachment(position: number): IMessageBuilder

- Defined in accessors/IModify.ts:320
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 accessors/IModify.ts:312
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: Array<IMessageAttachment>): IMessageBuilder

- Defined in accessors/IModify.ts:298
Sets the attachments for the message, replacing and destroying all of the current attachments.

Parameters
- attachments: Array<IMessageAttachment>
  
  array of the attachments
Returns IMessageBuilder

setAvatarUrl

setAvatarUrl(avatarUrl: string): IMessageBuilder

- Defined in accessors/IModify.ts:266
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

setData

setData(message: IMessage): IMessageBuilder

- Defined in accessors/IModify.ts:209
Provides a convient 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 accessors/IModify.ts:328
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 accessors/IModify.ts:253
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

setRoom

setRoom(room: IRoom): IMessageBuilder

- Defined in accessors/IModify.ts:216
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 accessors/IModify.ts:228
Sets the sender of this message.

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

setText

setText(text: string): IMessageBuilder

- Defined in accessors/IModify.ts:240
Sets the text of the message.

Parameters
- text: string
  
  the actual text
Returns IMessageBuilder

setUsernameAlias

setUsernameAlias(alias: string): IMessageBuilder

- Defined in accessors/IModify.ts:278
Sets the display text of the sender's username that is visible.

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

Generated using TypeDoc