interface MessageNotifierInterface in Message Notify 7.2

Additional behaviors for a Entity Reference field.

Implementations that wish to provide an implementation of this should register it using CTools' plugin system.

Hierarchy

• interface \MessageNotifierInterface

File

plugins/notifier/abstract.inc, line 9

interface MessageNotifierInterface {

  /**
   * Constructor for the notifier.
   *
   * @param $plugin
   *   The notifier plugin object. Note the "options" values might have
   *   been overriden in message_notify_send_message().
   * @param Message $message
   *   The Message entity.
   */
  public function __construct($plugin, Message $message);

  /**
   * Entry point to send and process a message.
   *
   * @return
   *   TRUE or FALSE based on delivery status.
   */
  public function send();

  /**
   * Deliver a message via the required transport method.
   *
   * @param $output
   *   Array keyed by the view mode, and the rendered entity in the
   *   specified view mode.
   *
   * @return
   *   TRUE or FALSE based on delivery status.
   */
  public function deliver(array $output = array());

  /**
   * Post send operations.
   */
  public function postSend($result, array $output = array());

  /**
   * Determine if user can access notifier.
   */
  public function access();

}

Members

Name	Modifiers	Type	Description	Overrides
MessageNotifierInterface::access	public	function	Determine if user can access notifier.	1
MessageNotifierInterface::deliver	public	function	Deliver a message via the required transport method.	1
MessageNotifierInterface::postSend	public	function	Post send operations.	1
MessageNotifierInterface::send	public	function	Entry point to send and process a message.	1
MessageNotifierInterface::__construct	public	function	Constructor for the notifier.	1