Interface IRoomBuilder

kind

addCustomField

• addCustomField(key, value): IRoomBuilder

• Adds a custom field to the room. Note: This will replace an existing field with the same key should it exist already.

  Parameters

  • key: string

    the name of the key

  • value: object

    the value of the custom field

  Returns IRoomBuilder

addMemberToBeAddedByUsername

• addMemberToBeAddedByUsername(username): IRoomBuilder

• Adds a member to the room by username

  Parameters

  • username: string

    the user's username to add to the room

  Returns IRoomBuilder

addUsername

• addUsername(username): IRoomBuilder

• Adds a user to the room, these are by username until further notice.

  Parameters

  • username: string

    the user's username to add to the room

  Returns IRoomBuilder

  Deprecated

  in favor of addMemberToBeAddedByUsername. This method will be removed on version 2.0.0

getCreator

• getCreator(): IUser

• Gets the room's creator.

  Returns IUser

getCustomFields

• getCustomFields(): {
      [key: string]: object;
  }

• Gets the custom field property of the room.

  Returns {
      [key: string]: object;
  }

  • [key: string]: object

getDisplayName

• getDisplayName(): string

• Gets the display name of this room.

  Returns string

getDisplayingOfSystemMessages

• getDisplayingOfSystemMessages(): boolean

• Gets whether this room should display the system messages or not.

  Returns boolean

getIsDefault

• getIsDefault(): boolean

• Gets whether this room is a default room or not.

  Returns boolean

getIsReadOnly

• getIsReadOnly(): boolean

• Gets whether this room is on read only state or not.

  Returns boolean

getMembersToBeAddedUsernames

• getMembersToBeAddedUsernames(): string[]

• Gets the list of usernames of the members who are been added to the room

  Returns string[]

getRoom

• getRoom(): IRoom

• Gets the resulting room that has been built up to the point of calling this method. Note: modifying the returned value will have no effect.

  Returns IRoom

getSlugifiedName

• getSlugifiedName(): string

• Gets the slugified name of this room.

  Returns string

getType

• getType(): RoomType

• Gets the room's type.

  Returns RoomType

getUserIds

• getUserIds(): string[]

• Gets user ids of members from a direct message

  Returns string[]

getUsernames

• getUsernames(): string[]

• Gets the usernames of users in the room.

  Returns string[]

  Deprecated

  in favor of getMembersUsernames. This method will be removed on version 2.0.0

setCreator

• setCreator(creator): IRoomBuilder

• Sets the creator of the room.

  Parameters

  • creator: IUser

    the user who created the room

  Returns IRoomBuilder

setCustomFields

• setCustomFields(fields): IRoomBuilder

• Sets the entire custom field property to an object provided. This will overwrite every existing key/values which are unrecoverable.

  Parameters

  • fields: {
        [key: string]: object;
    }

    the data to set

    • [key: string]: object

  Returns IRoomBuilder

setData

• setData(room): IRoomBuilder

• Provides a convient way to set the data for the room. Note: Providing an "id" field here will be ignored.

  Parameters

  • room: Partial<IRoom>

    the room data to set

  Returns IRoomBuilder

setDefault

• setDefault(isDefault): IRoomBuilder

• Sets whether this room should be a default room or not. This means that new users will automatically join this room when they join the server.

  Parameters

  • isDefault: boolean

    room should be default or not

  Returns IRoomBuilder

setDisplayName

• setDisplayName(name): IRoomBuilder

• Sets the display name of this room.

  Parameters

  • name: string

    the display name of the room

  Returns IRoomBuilder

setDisplayingOfSystemMessages

• setDisplayingOfSystemMessages(displaySystemMessages): IRoomBuilder

• Sets whether this room should display the system messages (like user join, etc) or not. This means that whenever a system event, such as joining or leaving, happens then Rocket.Chat won't send the message to the channel.

  Parameters

  • displaySystemMessages: boolean

    whether the messages should display or not

  Returns IRoomBuilder

setMembersToBeAddedByUsernames

• setMembersToBeAddedByUsernames(usernames): IRoomBuilder

• Sets a list of members to the room by usernames

  Parameters

  • usernames: string[]

    the list of usernames

  Returns IRoomBuilder

setReadOnly

• setReadOnly(isReadOnly): IRoomBuilder

• Sets whether this room should be in read only state or not. This means that users without the required permission to talk when a room is muted will not be able to talk but instead will only be able to read the contents of the room.

  Parameters

  • isReadOnly: boolean

    whether it should be read only or not

  Returns IRoomBuilder

setSlugifiedName

• setSlugifiedName(name): IRoomBuilder

• Sets the slugified name of this room, it must align to the rules of Rocket.Chat room names otherwise there will be an error thrown (no spaces, special characters, etc).

  Parameters

  • name: string

    the slugified name

  Returns IRoomBuilder

setType

• setType(type): IRoomBuilder

• Sets the room's type.

  Parameters

  • type: RoomType

    the room type

  Returns IRoomBuilder

setUsernames

• setUsernames(usernames): IRoomBuilder

• Sets the usernames of who are joined to the room.

  Parameters

  • usernames: string[]

    the list of usernames

  Returns IRoomBuilder

  Deprecated

  in favor of setMembersByUsernames. This method will be removed on version 2.0.0