Interface IRoomRead

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

Hierarchy

IRoomRead

Index

Methods

getById getByName getCreatorUserById getCreatorUserByName getDirectByUsernames getLeaders getMembers getMessages getModerators getOwners

Methods

getById

getById(id): Promise<IRoom>
Gets a room by an id.
Parameters
- id: string
  
  the id of the room
Returns Promise<IRoom>
the room
- Defined in src/definition/accessors/IRoomRead.ts:16

getByName

getByName(name): Promise<IRoom>
Gets a room by its name.
Parameters
- name: string
  
  the name of the room
Returns Promise<IRoom>
the room
- Defined in src/definition/accessors/IRoomRead.ts:32

getCreatorUserById

getCreatorUserById(id): Promise<IUser>
Gets just the creator of the room by the room's id.
Parameters
- id: string
  
  the id of the room
Returns Promise<IUser>
the creator of the room
- Defined in src/definition/accessors/IRoomRead.ts:24

getCreatorUserByName

getCreatorUserByName(name): Promise<IUser>
Gets just the creator of the room by the room's name.
Parameters
- name: string
  
  the name of the room
Returns Promise<IUser>
the creator of the room
- Defined in src/definition/accessors/IRoomRead.ts:40

getDirectByUsernames

getDirectByUsernames(usernames): Promise<IRoom>
Gets a direct room with all usernames
Parameters
- usernames: string[]
  
  all usernames belonging to the direct room
Returns Promise<IRoom>
the room
- Defined in src/definition/accessors/IRoomRead.ts:63

getLeaders

getLeaders(roomId): Promise<IUser[]>
Get a list of the leaders of a given room
Parameters
- roomId: string
  
  the room's id
Returns Promise<IUser[]>
a list of the users with the leader role in the room
- Defined in src/definition/accessors/IRoomRead.ts:87

getMembers

getMembers(roomId): Promise<IUser[]>
Gets an iterator for all of the users in the provided room.
Parameters
- roomId: string
  
  the room's id
Returns Promise<IUser[]>
an iterator for the users in the room
- Defined in src/definition/accessors/IRoomRead.ts:56

getMessages

getMessages(roomId): 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
- Defined in src/definition/accessors/IRoomRead.ts:48

getModerators

getModerators(roomId): Promise<IUser[]>
Get a list of the moderators of a given room
Parameters
- roomId: string
  
  the room's id
Returns Promise<IUser[]>
a list of the users with the moderator role in the room
- Defined in src/definition/accessors/IRoomRead.ts:71

getOwners

getOwners(roomId): Promise<IUser[]>
Get a list of the owners of a given room
Parameters
- roomId: string
  
  the room's id
Returns Promise<IUser[]>
a list of the users with the owner role in the room
- Defined in src/definition/accessors/IRoomRead.ts:79

Generated using TypeDoc