interface ActivityContextInterface in Open Social 8.5

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 10

Namespace

Drupal\activity_creator\Plugin

interface ActivityContextInterface extends PluginInspectionInterface {

  /**
   * Returns a batched list of recipients for this context.
   *
   * Format
   * array(
   *   array (
   *     id = uid or gip
   *     type = "user / group"
   *   )
   * )
   */
  public function getRecipients(array $data, $last_id, $limit);

  /**
   * Determines if the entity is valid for this context.
   */
  public function isValidEntity($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