interface MessageNotifierInterface in Message Notify 8

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 \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface
  • interface \Drupal\message_notify\Plugin\Notifier\MessageNotifierInterface

1 string reference to 'MessageNotifierInterface'

message_notify.services.yml in ./message_notify.services.yml

message_notify.services.yml

File

src/Plugin/Notifier/MessageNotifierInterface.php, line 16

Namespace

Drupal\message_notify\Plugin\Notifier

interface MessageNotifierInterface extends ContainerFactoryPluginInterface, PluginInspectionInterface, DerivativeInspectionInterface {

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

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

  /**
   * Act upon send result.
   *
   * @param bool $result
   *   The result from delivery.
   * @param array $output
   *   The message output array.
   */
  public function postSend($result, array $output = []);

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

  /**
   * Set the message object for the notifier.
   *
   * @param \Drupal\message\MessageInterface $message
   *   The message object.
   */
  public function setMessage(MessageInterface $message);

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
MessageNotifierInterface::access	public	function	Determine if user can access notifier.	1
MessageNotifierInterface::deliver	public	function	Deliver a message via the required transport method.	3
MessageNotifierInterface::postSend	public	function	Act upon send result.	1
MessageNotifierInterface::send	public	function	Entry point to send and process a message.	1
MessageNotifierInterface::setMessage	public	function	Set the message object for the notifier.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2