interface ActivityActionInterface in Open Social 8

Defines an interface for Activity action plugins.

Hierarchy

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

File

modules/custom/activity_creator/src/Plugin/ActivityActionInterface.php, line 10

Namespace

Drupal\activity_creator\Plugin

interface ActivityActionInterface extends PluginInspectionInterface {

  /**
   * Creates a new message on the action with some logic behind it.
   */
  public function create($entity);

  /**
   * Dumb function that can be called to create the message.
   */
  public function createMessage($entity);

  /**
   * Checks if this is a valid entity for the action.
   */
  public function isValidEntity($entity);

}

Members

Name	Modifiers	Type	Description	Overrides
ActivityActionInterface::create	public	function	Creates a new message on the action with some logic behind it.	1
ActivityActionInterface::createMessage	public	function	Dumb function that can be called to create the message.	1
ActivityActionInterface::isValidEntity	public	function	Checks if this is a valid entity for the action.	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