ChannelInterface.php in Courier 8

Contains \Drupal\courier\ChannelInterface.

Namespace

Drupal\courier

File

src/ChannelInterface.php

<?php

/**
 * @file
 * Contains \Drupal\courier\ChannelInterface.
 */
namespace Drupal\courier;

use Drupal\Core\Entity\FieldableEntityInterface;

/**
 * Defines an interface for channels (templates).
 */
interface ChannelInterface extends FieldableEntityInterface, TokenInterface {

  /**
   * Applies tokens to relevant fields.
   *
   * @return static
   *   Return this instance for chaining.
   */
  public function applyTokens();

  /**
   * Sends messages in bulk.
   *
   * @param \Drupal\courier\ChannelInterface[] $messages
   *   An array of messages.
   * @param array $options
   *   Miscellaneous options.
   *
   * @throws \Drupal\courier\Exception\ChannelFailure
   *   Throw if the message cannot be sent.
   */
  public static function sendMessages(array $messages, $options = []);

  /**
   * Sends this message.
   *
   * @param array $options
   *   Miscellaneous options to pass to the sender.
   */
  public function sendMessage(array $options = []);

  /**
   * Determine if there is enough data to transmit a message.
   *
   * Ideally some validation should also be done on the entity form.
   *
   * @return bool
   */
  public function isEmpty();

  /**
   * Import the message values from configuration values into this entity, as
   * found in the 'courier.template.TYPE' config type. Where TYPE is the entity
   * type ID of this entity.
   *
   * This method is the reverse of {@link exportTemplate()}
   *
   * @param mixed $content
   *   Values from a 'courier.template.TYPE' configuration.
   */
  public function importTemplate($content);

  /**
   * Export the message values from this template to configuration values, as
   * found in the 'courier.template.TYPE' config type. Where TYPE is the entity
   * type ID of this entity.
   *
   * This method is the reverse of {@link importTemplate()}
   *
   * @return mixed
   *   Values from this entity converted to 'courier.template.TYPE'
   *   configuration.
   */
  public function exportTemplate();

}

Interfaces

Name	Description
ChannelInterface	Defines an interface for channels (templates).