public function IdentityChannelPluginInterface::applyIdentity in Courier 8

Same name and namespace in other branches

1. 2.x src/Plugin/IdentityChannel/IdentityChannelPluginInterface.php \Drupal\courier\Plugin\IdentityChannel\IdentityChannelPluginInterface::applyIdentity()

Inserts the identity into the message.

Parameters

\Drupal\courier\ChannelInterface $message: The message. Passed by reference.

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.

3 methods override IdentityChannelPluginInterface::applyIdentity()

Broken::applyIdentity in src/Plugin/IdentityChannel/Broken.php

Inserts the identity into the message.

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

Inserts the identity into the message.

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

Inserts the identity into the message.

File

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

Contains \Drupal\courier\Plugin\IdentityChannel\IdentityChannelPluginInterface.

Class

IdentityChannelPluginInterface

Interface for IdentityChannel plugins.

Namespace

Drupal\courier\Plugin\IdentityChannel

Code

public function applyIdentity(ChannelInterface &$message, EntityInterface $identity);