Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRoomRead

This accessor provides methods for accessing rooms in a read-only-fashion.

Hierarchy

  • IRoomRead

Index

Methods

getById

  • getById(id: string): Promise<IRoom | undefined>

getByName

  • getByName(name: string): Promise<IRoom | undefined>

getCreatorUserById

  • getCreatorUserById(id: string): Promise<IUser | undefined>

getCreatorUserByName

  • getCreatorUserByName(name: string): Promise<IUser | undefined>
  • Gets just the creator of the room by the room's name.

    Parameters

    • name: string

      the name of the room

    Returns Promise<IUser | undefined>

    the creator of the room

getDirectByUsernames

  • getDirectByUsernames(usernames: Array<string>): Promise<IRoom>

getMembers

  • getMembers(roomId: string): Promise<Array<IUser>>
  • Gets an iterator for all of the users in the provided room.

    Parameters

    • roomId: string

      the room's id

    Returns Promise<Array<IUser>>

    an iterator for the users in the room

getMessages

  • getMessages(roomId: string): Promise<IterableIterator<IMessage>>
  • Gets an iterator for all of the messages in the provided room.

    Parameters

    • roomId: string

      the room's id

    Returns Promise<IterableIterator<IMessage>>

    an iterator for messages

Generated using TypeDoc