interface AppInterface in Apigee Edge 8

Defines an interface for App entity objects.

Hierarchy

• interface \Drupal\apigee_edge\Entity\EdgeEntityInterface extends \Apigee\Edge\Entity\EntityInterface; interface \Drupal\Core\Entity\FieldableEntityInterface
  • interface \Drupal\apigee_edge\Entity\FieldableEdgeEntityInterface extends \Drupal\apigee_edge\Entity\IteratorAggregate
    • interface \Drupal\apigee_edge\Entity\AttributesAwareFieldableEdgeEntityBaseInterface
      • interface \Drupal\apigee_edge\Entity\AppInterface extends \Apigee\Edge\Api\Management\Entity\AppInterface

25 files declare their use of AppInterface

apigee_edge.module in ./apigee_edge.module

Copyright 2018 Google Inc.

apigee_edge_actions.module in modules/apigee_edge_actions/apigee_edge_actions.module

AppAnalyticsFormBase.php in src/Form/AppAnalyticsFormBase.php

AppApiKeyAddFormBase.php in src/Form/AppApiKeyAddFormBase.php

AppApiKeyConfirmFormBase.php in src/Form/AppApiKeyConfirmFormBase.php

... See full list

File

src/Entity/AppInterface.php, line 28

Namespace

Drupal\apigee_edge\Entity

interface AppInterface extends EdgeAppInterface, AttributesAwareFieldableEdgeEntityBaseInterface {

  /**
   * Returns the id of the app owner from the app entity.
   *
   * Return value could be either the developer id or the company name.
   *
   * @return string
   *   Id of the app owner, or null if the app is new.
   */
  public function getAppOwner() : ?string;

  /**
   * Sets the app owner's property value on an app.
   *
   * @param string $owner
   *   The owner of the app. Developer id (uuid) or team (company) name.
   */
  public function setAppOwner(string $owner) : void;

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
AppInterface::getAppOwner	public	function	Returns the id of the app owner from the app entity.	2
AppInterface::setAppOwner	public	function	Sets the app owner's property value on an app.	2
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
EdgeEntityInterface::createFrom	public static	function	Creates a Drupal entity from an SDK Entity.	1
EdgeEntityInterface::decorated	public	function	Returns the decorated SDK entity.	1
EdgeEntityInterface::uniqueIdProperties	public static	function	Returns all unique ids how an entity can be referenced in Apigee Edge.	1
EdgeEntityInterface::uniqueIds	public	function	List of unique ids how an entity can be referenced in Apigee Edge.	1
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
FieldableEdgeEntityInterface::setPropertyValue	public	function	Updates the property value on an entity by field name.	1
FieldableEntityInterface::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type.	2
FieldableEntityInterface::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle.	2
FieldableEntityInterface::get	public	function	Gets a field item list.	1
FieldableEntityInterface::getFieldDefinition	public	function	Gets the definition of a contained field.	1
FieldableEntityInterface::getFieldDefinitions	public	function	Gets an array of field definitions of all contained fields.	1
FieldableEntityInterface::getFields	public	function	Gets an array of all field item lists.	1
FieldableEntityInterface::getTranslatableFields	public	function	Gets an array of field item lists for translatable fields.	1
FieldableEntityInterface::hasField	public	function	Determines whether the entity has a field with the given name.	1
FieldableEntityInterface::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity.	1
FieldableEntityInterface::onChange	public	function	Reacts to changes to a field.	1
FieldableEntityInterface::set	public	function	Sets a field value.	1
FieldableEntityInterface::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity.	1
FieldableEntityInterface::validate	public	function	Validates the currently set values.	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