Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDiscussionBuilder

Interface for building out a room. Please note, a room creator, name, and type must be set otherwise you will NOT be able to successfully save the room object.

Hierarchy

Index

Properties

kind

Methods

addCustomField

addMemberToBeAddedByUsername

  • addMemberToBeAddedByUsername(username: string): IRoomBuilder

addUsername

getCreator

getCustomFields

  • getCustomFields(): object

getDisplayName

  • getDisplayName(): string

getDisplayingOfSystemMessages

  • getDisplayingOfSystemMessages(): boolean

getIsDefault

  • getIsDefault(): boolean

getIsReadOnly

  • getIsReadOnly(): boolean

getMembersToBeAddedUsernames

  • getMembersToBeAddedUsernames(): Array<string>

getParentMessage

getParentRoom

getReply

  • getReply(): string

getRoom

getSlugifiedName

  • getSlugifiedName(): string

getType

getUserIds

  • getUserIds(): Array<string>

getUsernames

  • getUsernames(): Array<string>

setCreator

setCustomFields

setData

setDefault

setDisplayName

setDisplayingOfSystemMessages

  • setDisplayingOfSystemMessages(displaySystemMessages: boolean): IRoomBuilder

setMembersToBeAddedByUsernames

  • setMembersToBeAddedByUsernames(usernames: Array<string>): IRoomBuilder

setParentMessage

setParentRoom

setReadOnly

  • 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

setReply

setSlugifiedName

setType

setUsernames

Generated using TypeDoc