Interface INotifier

Hierarchy

INotifier

Index

Methods

Methods

getMessageBuilder

getMessageBuilder(): IMessageBuilder

- Defined in accessors/IModify.ts:45
Gets a new message builder for building a notification message.

Returns IMessageBuilder

notifyRoom

notifyRoom(room: IRoom, message: IMessage): Promise<void>

- Defined in accessors/IModify.ts:42
Notifies all of the users in the provided room.

Note: Notifications only are shown to those online and it only stays around for the duration of their session.

Parameters
- room: IRoom
  
  The room which to notify the users in
- message: IMessage
  
  The message content to notify users about
Returns Promise<void>

notifyUser

notifyUser(user: IUser, message: IMessage): Promise<void>

- Defined in accessors/IModify.ts:31
Notifies the provided user of the provided message.

Note: Notifications only are shown to the user if they are online and it only stays around for the duration of their session.

Parameters
- user: IUser
  
  The user who should be notified
- message: IMessage
  
  The message with the content to notify the user about
Returns Promise<void>

Generated using TypeDoc