Interface IPreMessageUpdatedPrevent

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

Hierarchy

IPreMessageUpdatedPrevent

Index

Methods

checkPreMessageUpdatedPrevent? executePreMessageUpdatedPrevent

Methods

`Optional` checkPreMessageUpdatedPrevent

checkPreMessageUpdatedPrevent(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 updated.
Parameters
- message: IMessage
  
  The message which is being updated
- 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/IPreMessageUpdatedPrevent.ts:16

executePreMessageUpdatedPrevent

executePreMessageUpdatedPrevent(message, read, http, persistence): Promise<boolean>
Method which is to be used to prevent a message from being updated.
Parameters
- message: IMessage
  
  The message about to be updated
- 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 updated
- Defined in src/definition/messages/IPreMessageUpdatedPrevent.ts:27

Generated using TypeDoc