class SearchApiSavedSearchesNotification in Search API Saved Searches 8

Defines a notification plugin annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\search_api_saved_searches\Annotation\SearchApiSavedSearchesNotification

See also

\Drupal\search_api_saved_searches\Notification\NotificationPluginManager

\Drupal\search_api_saved_searches\Notification\NotificationPluginInterface

\Drupal\search_api_saved_searches\Notification\NotificationPluginBase

Plugin API

1 class is annotated with SearchApiSavedSearchesNotification

Email in src/Plugin/search_api_saved_searches/notification/Email.php

Provides e-mails as a notification mechanism.

File

src/Annotation/SearchApiSavedSearchesNotification.php, line 17

Namespace

Drupal\search_api_saved_searches\Annotation

class SearchApiSavedSearchesNotification extends Plugin {

  /**
   * The notification plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the notification plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The notification description.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
SearchApiSavedSearchesNotification::$description	public	property	The notification description.
SearchApiSavedSearchesNotification::$id	public	property	The notification plugin ID.
SearchApiSavedSearchesNotification::$label	public	property	The human-readable name of the notification plugin.