import { IHttp, IModify, IPersistence, IRead } from '../accessors';
import { IMessage } from './IMessage';

/** Handler for after a message is updated. */
export interface IPostMessageUpdated {
    /**
     * Enables the handler to signal to the Apps framework whether
     * this handler should actually be executed for after the message
     * has been updated.
     *
     * @param message The message which was updated
     * @param read An accessor to the environment
     * @param http An accessor to the outside world
     * @returns whether to run the executor function
     */
    checkPostMessageUpdated?(message: IMessage, read: IRead, http: IHttp): Promise<boolean>;

    /**
     * Method called *after* the message is updated to the other clients.
     *
     * @param message The message which was updated
     * @param read An accessor to the environment
     * @param http An accessor to the outside world
     * @param persistence An accessor to the App's persistence
     */
    executePostMessageUpdated(message: IMessage, read: IRead, http: IHttp, persistence: IPersistence, modify: IModify): Promise<void>;
}