Interface IPreMessageSentModify

Handler called when an App wants to modify a message in a destructive way.

Hierarchy

IPreMessageSentModify

Index

Methods

checkPreMessageSentModify? executePreMessageSentModify

Methods

`Optional` checkPreMessageSentModify

checkPreMessageSentModify(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 execute or not
- Defined in src/definition/messages/IPreMessageSentModify.ts:16

executePreMessageSentModify

executePreMessageSentModify(message, builder, read, http, persistence): Promise<IMessage>
Method which is to be used to destructively modify the message.
Parameters
- message: IMessage
  
  The message about to be sent
- builder: IMessageBuilder
  
  The builder for modifying the message via methods
- read: IRead
  
  An accessor to the environment
- http: IHttp
  
  An accessor to the outside world
- persistence: IPersistence
  
  An accessor to the App's persistence
Returns Promise<IMessage>
the resulting message
- Defined in src/definition/messages/IPreMessageSentModify.ts:28

Generated using TypeDoc