You are here

interface EmailFrequencyInterface in Open Social 8.2

Same name and namespace in other branches
  1. 8.9 modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  2. 8 modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  3. 8.3 modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  4. 8.4 modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  5. 8.5 modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  6. 8.6 modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  7. 8.7 modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  8. 8.8 modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  9. 10.3.x modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  10. 10.0.x modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  11. 10.1.x modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface
  12. 10.2.x modules/custom/activity_send/modules/activity_send_email/src/EmailFrequencyInterface.php \Drupal\activity_send_email\EmailFrequencyInterface

Common interface for all email frequencies.

Hierarchy

Expanded class hierarchy of EmailFrequencyInterface

All classes that implement EmailFrequencyInterface

File

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

Namespace

Drupal\activity_send_email
View source
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.
   */
  public function processItem(Activity $activity, Message $message, User $target);

}

Members

Namesort descending 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