interface ActivityContextInterface in Open Social 10.3.x

Defines an interface for Activity content plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\activity_creator\Plugin\ActivityContextInterface

File

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

Namespace

Drupal\activity_creator\Plugin

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

Name	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