interface EmailFrequencyInterface in Open Social 10.1.x

Common interface for all email frequencies.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\activity_send_email\EmailFrequencyInterface

File

modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php, line 13

Namespace

Drupal\activity_send_email

interface EmailFrequencyInterface extends PluginInspectionInterface {

  /**
   * Return the name of the email frequency.
   *
   * @return string
   *   The name of the email frequency.
   */
  public function getName();

  /**
   * Return the weight of the frequency option.
   *
   * @return int
   *   The weight of the frequency option.
   */
  public function getWeight();

  /**
   * Return the interval of the email frequency in seconds.
   *
   * @return int
   *   The interval in seconds.
   */
  public function getInterval();

  /**
   * Processes an activity item.
   *
   * @param \Drupal\activity_creator\Entity\Activity $activity
   *   The Activity object.
   * @param \Drupal\message\Entity\Message $message
   *   The Message object.
   * @param \Drupal\user\Entity\User $target
   *   The target user account.
   * @param string|null $body_text
   *   The output text of message.
   */
  public function processItem(Activity $activity, Message $message, User $target, $body_text = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
EmailFrequencyInterface::getInterval	public	function	Return the interval of the email frequency in seconds.	1
EmailFrequencyInterface::getName	public	function	Return the name of the email frequency.	1
EmailFrequencyInterface::getWeight	public	function	Return the weight of the frequency option.	1
EmailFrequencyInterface::processItem	public	function	Processes an activity item.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2