You are here

Home » API reference » Heartbeat 8 » HeartbeatTypeInterface.php

interface HeartbeatTypeInterface in Heartbeat 8

Provides an interface for defining Heartbeat type entities.

Hierarchy

Expanded class hierarchy of HeartbeatTypeInterface

All classes that implement HeartbeatTypeInterface

File

src/Entity/HeartbeatTypeInterface.php, line 10

Namespace

Drupal\heartbeat\Entity
View source 
interface HeartbeatTypeInterface extends ConfigEntityInterface {

  /*
   * Sets the unique Message ID
   *
   * @param string $messageId
   *  The unique Message ID to represent
   *  all messages of this type
   */
  public function setMessageId($messageId);

  /*
   * Gets the unique Message ID
   *
   * @return string
   *  The Stream's Message ID
   */
  public function getMessageId();

  /**
   * Sets the description of the stream
   *
   * @param string $description
   *  Describing streams of this type
   */
  public function setDescription($description);

  /**
   * Gets the description of the HeartbeatType
   *
   * @return string
   *  The Stream's description
   */
  public function getDescription();

  /**
   * Sets the main Entity Type of the Heartbeat Type
   *
   * @param string $mainentity
   *  Describing entity type used in this Heartbeat Type
   */
  public function setMainEntity($mainentity);

  /**
   * Gets the main Entity Type of the Heartbeat Type
   *
   * @return string
   *  The Heartbeat Type's main Entity Type
   */
  public function getMainEntity();

  /**
   * Sets the translatable message
   * This message creates the structure of each message
   *
   * @param string $message
   *  The template message serving as the foundation of each message structure of this stream type
   */
  public function setMessage($message);

  /**
   * Gets the translatable message of the stream
   *
   * @return string
   *  The Stream's message
   */
  public function getMessage();

  //  /**
  //   * Sets the translatable concatenated message
  //   *
  //   * @param string $messageConcat
  //   *
  //   */
  //
  //  public function setMessageConcat($messageConcat);
  //
  //
  //  /**
  //   * Gets the concatenated message of the stream
  //   *
  //   * @return string
  //   *  The Stream's concatenated message
  //   */
  //
  //  public function getMessageConcat();

  /**
   * Sets the Permissions for this message stream
   *
   * @param int $perms
   *
   */
  public function setPerms($perms);

  /**
   * Gets the Permissions of this message stream
   *
   * @return int
   *  The stream's permissions
   */
  public function getPerms();

  /**
   * Sets the Group Type for this message stream
   *
   * @param string $groupType
   *
   */
  public function setGroupType($groupType);

  /**
   * Gets the Group Type of this message stream
   *
   * @return string
   *  The stream's Group Type
   */
  public function getGroupType();

  /**
   * Sets the arguments for the concatenated message
   *
   * @param string $arguments
   *
   */
  public function setArguments($arguments);

  /**
   * Gets the arguments for the concatenated message
   *
   * @return string
   *  The stream's arguments for the concatenated message
   */
  public function getArguments();

  /**
   * Sets the variables for this message stream
   *
   * @param string $variables
   *
   */
  public function setVariables($variables);

  /**
   * Gets the variables of this message stream
   *
   * @return string
   *  The stream's variables
   */
  public function getVariables();

  /**
   * Sets the bundle targeted for this Heartbeat type
   *
   * @param string $variables
   *
   */
  public function setBundle($bundle);

  /**
   * Gets the bundle of this Heartbeat type
   *
   * @return string
   *  The stream's variables
   */
  public function getBundle();

  /**
   * @return mixed
   */
  public function setWeight($weight);

  /**
   * @param $weight
   * @return mixed
   */
  public function getWeight();

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
HeartbeatTypeInterface::getArguments public function Gets the arguments for the concatenated message 1
HeartbeatTypeInterface::getBundle public function Gets the bundle of this Heartbeat type 1
HeartbeatTypeInterface::getDescription public function Gets the description of the HeartbeatType 1
HeartbeatTypeInterface::getGroupType public function Gets the Group Type of this message stream 1
HeartbeatTypeInterface::getMainEntity public function Gets the main Entity Type of the Heartbeat Type 1
HeartbeatTypeInterface::getMessage public function Gets the translatable message of the stream 1
HeartbeatTypeInterface::getMessageId public function 1
HeartbeatTypeInterface::getPerms public function Gets the Permissions of this message stream 1
HeartbeatTypeInterface::getVariables public function Gets the variables of this message stream 1
HeartbeatTypeInterface::getWeight public function 1
HeartbeatTypeInterface::setArguments public function Sets the arguments for the concatenated message 1
HeartbeatTypeInterface::setBundle public function Sets the bundle targeted for this Heartbeat type 1
HeartbeatTypeInterface::setDescription public function Sets the description of the stream 1
HeartbeatTypeInterface::setGroupType public function Sets the Group Type for this message stream 1
HeartbeatTypeInterface::setMainEntity public function Sets the main Entity Type of the Heartbeat Type 1
HeartbeatTypeInterface::setMessage public function Sets the translatable message This message creates the structure of each message 1
HeartbeatTypeInterface::setMessageId public function 1
HeartbeatTypeInterface::setPerms public function Sets the Permissions for this message stream 1
HeartbeatTypeInterface::setVariables public function Sets the variables for this message stream 1
HeartbeatTypeInterface::setWeight public function 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5