Interface INotifier

Hierarchy

INotifier

Index

Methods

getMessageBuilder notifyRoom notifyUser typing

Methods

getMessageBuilder

getMessageBuilder(): IMessageBuilder
Gets a new message builder for building a notification message.

Returns IMessageBuilder
- Defined in src/definition/accessors/INotifier.ts:62

notifyRoom

notifyRoom(room, message): Promise<void>
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>
- Defined in src/definition/accessors/INotifier.ts:52

notifyUser

notifyUser(user, message): Promise<void>
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>
- Defined in src/definition/accessors/INotifier.ts:41

typing

typing(options): Promise<(() => Promise<void>)>
Notifies all of the users a typing indicator in the provided scope.
Parameters
- options: ITypingOptions
Returns Promise<(() => Promise<void>)>
a cancellation function to stop typing
- Defined in src/definition/accessors/INotifier.ts:59

Generated using TypeDoc