You are here

interface PrivateMessageThreadManagerInterface in Private Message 8

Same name and namespace in other branches
  1. 8.2 src/Service/PrivateMessageThreadManagerInterface.php \Drupal\private_message\Service\PrivateMessageThreadManagerInterface

Handles the generation/update of private messages, threads, and metadata.

@package Drupal\private_message\Service

Hierarchy

Expanded class hierarchy of PrivateMessageThreadManagerInterface

All classes that implement PrivateMessageThreadManagerInterface

1 file declares its use of PrivateMessageThreadManagerInterface
PrivateMessageForm.php in src/Form/PrivateMessageForm.php

File

src/Service/PrivateMessageThreadManagerInterface.php, line 13

Namespace

Drupal\private_message\Service
View source
interface PrivateMessageThreadManagerInterface {

  /**
   * Saves a private message thread.
   *
   * A new thread will be created if one does not already exist.
   *
   * @param \Drupal\private_message\Entity\PrivateMessageInterface $message
   *   The new message object.
   * @param array $recipients
   *   (optional) An array of message recipients. Defaults to an empty array.
   * @param array $excludeFromMail
   *   (optional) An array of members to exclude from notification emails.
   *   Defaults to an empty array.
   * @param \Drupal\private_message\Entity\PrivateMessageThreadInterface|null $thread
   *   (optional) The private message thread. If NULL, one will be loaded
   *   using the recipients array.
   */
  public function saveThread(PrivateMessageInterface $message, array $recipients = [], array $excludeFromMail = [], PrivateMessageThreadInterface $thread = NULL);

}

Members

Namesort descending Modifiers Type Description Overrides
PrivateMessageThreadManagerInterface::saveThread public function Saves a private message thread. 1