Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPreMessageSentExtend

Handler called when an App wants to enrich a message.

Hierarchy

  • IPreMessageSentExtend

Index

Methods

Optional checkPreMessageSentExtend

  • checkPreMessageSentExtend(message: IMessage, read: IRead, http: IHttp): 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

executePreMessageSentExtend

  • Method which is to be used to non-destructively enrich the message.

    Parameters

    • message: IMessage

      The message about to be sent

    • extend: IMessageExtender

      An accessor for modifying the message non-destructively

    • 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<IMessage>

    the resulting message

Generated using TypeDoc