interface iHeartbeatPlugin in Heartbeat 7

iHeartbeatPlugin interface.

Hierarchy

• interface \iHeartbeatPlugin

File

modules/heartbeat_plugins/includes/heartbeat_plugin.inc, line 57

interface iHeartbeatPlugin {

  /**
   * loadAttachments().
   * Loads extra attachments into the heartbeat activity message, which
   * can and must be used when preparing for display.
   */
  public function loadAttachments(HeartbeatActivity &$heartbeatActivity, $name = NULL);

  /**
   * hasContent().
   * True if a plugin provides attachments.
   */
  public function hasContent();

  /**
   * hasAttachmentsContent().
   * True if the message has attachments content.
   */
  public function hasAttachmentsContent();

  /**
   * renderAttachmentsContent().
   */
  public function renderAttachmentsContent(HeartbeatActivity $heartbeatActivity);

  /**
   * hasButtons().
   * True if a plugin provides attachments.
   */
  public function hasButtons();

  /**
   * hasAttachmentsButtons().
   * True if a message has attachment buttons.
   */
  public function hasAttachmentsButtons();

  /**
   * renderButtons().
   */
  public function renderButtons(HeartbeatActivity $heartbeatActivity);

  /**
   * isStreamAdaptor().
   */
  public function isStreamAdaptor();

  /**
   * adaptsStream().
   */
  public function adaptsStream();

  /**
   * streamLoaded().
   */
  public function streamLoaded(HeartbeatStream $heartbeatStream);

}

Members

Name	Modifiers	Type	Description	Overrides
iHeartbeatPlugin::adaptsStream	public	function	adaptsStream().	5
iHeartbeatPlugin::hasAttachmentsButtons	public	function	hasAttachmentsButtons(). True if a message has attachment buttons.	5
iHeartbeatPlugin::hasAttachmentsContent	public	function	hasAttachmentsContent(). True if the message has attachments content.	5
iHeartbeatPlugin::hasButtons	public	function	hasButtons(). True if a plugin provides attachments.	5
iHeartbeatPlugin::hasContent	public	function	hasContent(). True if a plugin provides attachments.	5
iHeartbeatPlugin::isStreamAdaptor	public	function	isStreamAdaptor().	5
iHeartbeatPlugin::loadAttachments	public	function	loadAttachments(). Loads extra attachments into the heartbeat activity message, which can and must be used when preparing for display.	5
iHeartbeatPlugin::renderAttachmentsContent	public	function	renderAttachmentsContent().	5
iHeartbeatPlugin::renderButtons	public	function	renderButtons().	5
iHeartbeatPlugin::streamLoaded	public	function	streamLoaded().	5