IdentityChannelPluginInterface.php in Courier 8

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

Namespace

Drupal\courier\Plugin\IdentityChannel

File

src/Plugin/IdentityChannel/IdentityChannelPluginInterface.php

<?php

/**
 * @file
 * Contains \Drupal\courier\Plugin\IdentityChannel\IdentityChannelPluginInterface.
 */
namespace Drupal\courier\Plugin\IdentityChannel;

use Drupal\courier\ChannelInterface;
use Drupal\Core\Entity\EntityInterface;

/**
 * Interface for IdentityChannel plugins.
 */
interface IdentityChannelPluginInterface {

  /**
   * Inserts the identity into the message.
   *
   * @param \Drupal\courier\ChannelInterface $message
   *   The message. Passed by reference.
   * @param 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);

}

Interfaces

Name	Description
IdentityChannelPluginInterface	Interface for IdentityChannel plugins.