You are here

interface ActivityContextInterface in Open Social 10.3.x

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

Defines an interface for Activity content plugins.

Hierarchy

Expanded class hierarchy of ActivityContextInterface

All classes that implement ActivityContextInterface

File

modules/custom/activity_creator/src/Plugin/ActivityContextInterface.php, line 11

Namespace

Drupal\activity_creator\Plugin
View source
interface ActivityContextInterface extends PluginInspectionInterface {

  /**
   * Returns a batched list of recipients for this context.
   *
   * @param array $data
   *   The data.
   * @param int $last_id
   *   The last ID.
   * @param int $limit
   *   The limit.
   *
   * @return array
   *   An associative array of recipients, containing the following key-value
   *   pairs:
   *   - target_type: The entity type ID.
   *   - target_id: The entity ID.
   */
  public function getRecipients(array $data, $last_id, $limit);

  /**
   * Determines if the entity is valid for this context.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
   *
   * @return bool
   *   TRUE if it's valid entity.
   */
  public function isValidEntity(EntityInterface $entity);

}

Members

Namesort descending Modifiers Type Description Overrides
ActivityContextInterface::getRecipients public function Returns a batched list of recipients for this context. 1
ActivityContextInterface::isValidEntity public function Determines if the entity is valid for this context. 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