interface DeliveryCandidateInterface in Message Subscribe 8

Defines a subscription delivery candidate interface.

Hierarchy

• interface \Drupal\message_subscribe\Subscribers\DeliveryCandidateInterface

3 files declare their use of DeliveryCandidateInterface

DeliveryCandidateTest.php in tests/src/Unit/Subscribers/DeliveryCandidateTest.php

message_subscribe.api.php in ./message_subscribe.api.php

Hooks provided by the Message subscribe module.

message_subscribe_test.module in tests/modules/message_subscribe_test/message_subscribe_test.module

Test implementations of message_subscribe hooks.

File

src/Subscribers/DeliveryCandidateInterface.php, line 8

Namespace

Drupal\message_subscribe\Subscribers

interface DeliveryCandidateInterface {

  /**
   * Get the flags that triggered the subscription.
   *
   * @return string[]
   *   An array of subscription flag IDs that triggered the notification.
   */
  public function getFlags();

  /**
   * Sets the flags.
   *
   * @param array $flag_ids
   *   An array of flag IDs.
   *
   * @return static
   *   Return the object.
   */
  public function setFlags(array $flag_ids);

  /**
   * Adds a flag.
   *
   * @param string $flag_id
   *   The flag ID to add.
   *
   * @return static
   *   Return the object.
   */
  public function addFlag($flag_id);

  /**
   * Remove a flag.
   *
   * @param string $flag_id
   *   The flag ID to remove.
   *
   * @return static
   *   Return the object.
   */
  public function removeFlag($flag_id);

  /**
   * Get the notifier IDs.
   *
   * @return string[]
   *   An array of message notifier plugin IDs.
   */
  public function getNotifiers();

  /**
   * Sets the notifier IDs.
   *
   * @param string[] $notifier_ids
   *   An array of notifier IDs.
   *
   * @return static
   *   Return the object.
   */
  public function setNotifiers(array $notifier_ids);

  /**
   * Adds a notifier.
   *
   * @param string $notifier_id
   *   The notifier ID to add.
   *
   * @return static
   *   Return the object.
   */
  public function addNotifier($notifier_id);

  /**
   * Remove a notifier.
   *
   * @param string $notifier_id
   *   The notifier ID to remove.
   *
   * @return static
   *   Return the object.
   */
  public function removeNotifier($notifier_id);

  /**
   * Gets the account ID of the recipient.
   *
   * @return int
   *   The user ID for the delivery.
   */
  public function getAccountId();

  /**
   * Sets the account ID.
   *
   * @param int $uid
   *   The account ID of the delivery candidate.
   *
   * @return static
   *   Return the object.
   */
  public function setAccountId($uid);

}

Members

Name	Modifiers	Type	Description	Overrides
DeliveryCandidateInterface::addFlag	public	function	Adds a flag.	1
DeliveryCandidateInterface::addNotifier	public	function	Adds a notifier.	1
DeliveryCandidateInterface::getAccountId	public	function	Gets the account ID of the recipient.	1
DeliveryCandidateInterface::getFlags	public	function	Get the flags that triggered the subscription.	1
DeliveryCandidateInterface::getNotifiers	public	function	Get the notifier IDs.	1
DeliveryCandidateInterface::removeFlag	public	function	Remove a flag.	1
DeliveryCandidateInterface::removeNotifier	public	function	Remove a notifier.	1
DeliveryCandidateInterface::setAccountId	public	function	Sets the account ID.	1
DeliveryCandidateInterface::setFlags	public	function	Sets the flags.	1
DeliveryCandidateInterface::setNotifiers	public	function	Sets the notifier IDs.	1