interface IdentityChannelPluginInterface in Courier 2.x

Interface for IdentityChannel plugins.

Hierarchy

• interface \Drupal\courier\Plugin\IdentityChannel\IdentityChannelPluginInterface

2 files declare their use of IdentityChannelPluginInterface

User.php in src/Plugin/IdentityChannel/CourierEmail/User.php

User.php in tests/modules/courier_test_message/src/Plugin/IdentityChannel/TestMessage/User.php

File

src/Plugin/IdentityChannel/IdentityChannelPluginInterface.php, line 11

Namespace

Drupal\courier\Plugin\IdentityChannel

interface IdentityChannelPluginInterface {

  /**
   * Inserts the identity into the message.
   *
   * @param \Drupal\courier\ChannelInterface $message
   *   The message. Passed by reference.
   * @param \Drupal\Core\Entity\EntityInterface $identity
   *   The identity.
   *
   * @throws \Drupal\courier\Exception\IdentityException
   *   Thrown when an identity cannot be applied. Message is discarded, it does
   *   not stop creation of remaining messages in collection.
   */
  public function applyIdentity(ChannelInterface &$message, EntityInterface $identity);

}

Members

Name	Modifiers	Type	Description	Overrides
IdentityChannelPluginInterface::applyIdentity	public	function	Inserts the identity into the message.	3