interface MessageUiViewsContextualLinksInterface in Message UI 8

Defines an interface for Message UI views contextual links plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\message_ui\MessageUiViewsContextualLinksInterface

4 files declare their use of MessageUiViewsContextualLinksInterface

MessageUiContextualLinkDeleteMessage.php in src/Plugin/MessageUiViewsContextualLinks/MessageUiContextualLinkDeleteMessage.php

MessageUiContextualLinkEditMessage.php in src/Plugin/MessageUiViewsContextualLinks/MessageUiContextualLinkEditMessage.php

MessageUiContextualLinkNotifyMessage.php in modules/message_notify_ui/src/Plugin/MessageUiViewsContextualLinks/MessageUiContextualLinkNotifyMessage.php

MessageUiContextualLinkViewMessage.php in src/Plugin/MessageUiViewsContextualLinks/MessageUiContextualLinkViewMessage.php

File

src/MessageUiViewsContextualLinksInterface.php, line 11

Namespace

Drupal\message_ui

interface MessageUiViewsContextualLinksInterface extends PluginInspectionInterface {

  /**
   * Set the message object.
   *
   * @param \Drupal\message\Entity\Message $message
   *   The message object.
   *
   * @return \Drupal\message_ui\MessageUiViewsContextualLinksInterface
   *   The current object.
   */
  public function setMessage(Message $message);

  /**
   * Get te message object.
   *
   * @return \Drupal\message\Entity\Message
   *   The message object.
   */
  public function getMessage();

  /**
   * Return the an array with the router ID and message info.
   *
   * @return array
   *   Array contains the title and the URL.
   */
  public function getRouterInfo();

  /**
   * Checking if the user have access to do the action.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   Access result interface object.
   */
  public function access();

}

Members

Name	Modifiers	Type	Description	Overrides
MessageUiViewsContextualLinksInterface::access	public	function	Checking if the user have access to do the action.	4
MessageUiViewsContextualLinksInterface::getMessage	public	function	Get te message object.	1
MessageUiViewsContextualLinksInterface::getRouterInfo	public	function	Return the an array with the router ID and message info.	4
MessageUiViewsContextualLinksInterface::setMessage	public	function	Set the message object.	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