Interface IPreMessageSentPrevent

Handler which is called to determine whether a user is allowed to send a message or not.

Hierarchy

IPreMessageSentPrevent

Index

Methods

checkPreMessageSentPrevent? executePreMessageSentPrevent

Methods

`Optional` checkPreMessageSentPrevent

checkPreMessageSentPrevent(message, read, http): Promise<boolean>
Enables the handler to signal to the Apps framework whether this handler should actually be executed for the message about to be sent.
Parameters
- message: IMessage
  
  The message which is being sent
- read: IRead
  
  An accessor to the environment
- http: IHttp
  
  An accessor to the outside world
Returns Promise<boolean>
whether to run the prevent or not
- Defined in src/definition/messages/IPreMessageSentPrevent.ts:16

executePreMessageSentPrevent

executePreMessageSentPrevent(message, read, http, persistence): Promise<boolean>
Method which is to be used to prevent a message from being sent.
Parameters
- message: IMessage
  
  The message about to be sent
- read: IRead
  
  An accessor to the environment
- http: IHttp
  
  An accessor to the outside world
- persistence: IPersistence
  
  An accessor to the App's persistence storage
Returns Promise<boolean>
whether to prevent the message from being sent
- Defined in src/definition/messages/IPreMessageSentPrevent.ts:27

Generated using TypeDoc