interface TeamInvitationInterface in Apigee Edge 8

Provides an interface for defining invitation entities.

Hierarchy

interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable; interface \Drupal\user\EntityOwnerInterface
- interface \Drupal\apigee_edge_teams\Entity\TeamInvitationInterface

Expanded class hierarchy of TeamInvitationInterface

All classes that implement TeamInvitationInterface

12 files declare their use of TeamInvitationInterface

AddTeamMembersForm.php in modules/apigee_edge_teams/src/Form/AddTeamMembersForm.php
apigee_edge_teams.module in modules/apigee_edge_teams/apigee_edge_teams.module: Copyright 2018 Google Inc.
TeamInvitationAcceptForm.php in modules/apigee_edge_teams/src/Entity/Form/TeamInvitationAcceptForm.php
TeamInvitationDeclineForm.php in modules/apigee_edge_teams/src/Entity/Form/TeamInvitationDeclineForm.php
TeamInvitationEvent.php in modules/apigee_edge_teams/src/Event/TeamInvitationEvent.php

... See full list

File

modules/apigee_edge_teams/src/Entity/TeamInvitationInterface.php, line 29

Namespace

Drupal\apigee_edge_teams\Entity

View source

interface TeamInvitationInterface extends ContentEntityInterface, EntityOwnerInterface {

  /**
   * Invitation is expired.
   */
  const STATUS_EXPIRED = -1;

  /**
   * Invitation is sent and pending.
   */
  const STATUS_PENDING = 0;

  /**
   * Invitation is accepted.
   */
  const STATUS_ACCEPTED = 1;

  /**
   * Invitation is declined.
   */
  const STATUS_DECLINED = 2;

  /**
   * Returns the label for this invitation.
   *
   * @return string
   *   The label.
   */
  public function getLabel() : string;

  /**
   * Sets the invitation label.
   *
   * @param string $label
   *   The invitation label.
   *
   * @return \Drupal\apigee_edge_teams\Entity\TeamInvitationInterface
   *   The invitation.
   */
  public function setLabel(string $label) : self;

  /**
   * Returns the team entity.
   *
   * @return \Drupal\apigee_edge_teams\Entity\TeamInterface|null
   *   The team entity or null.
   */
  public function getTeam() : ?TeamInterface;

  /**
   * Sets the team of the invitation.
   *
   * @param \Drupal\apigee_edge_teams\Entity\TeamInterface $team
   *   The team entity.
   *
   * @return \Drupal\apigee_edge_teams\Entity\TeamInvitationInterface
   *   The invitation.
   */
  public function setTeam(TeamInterface $team) : self;

  /**
   * Returns the team roles.
   *
   * @return \Drupal\apigee_edge_teams\Entity\TeamRoleInterface[]|null
   *   The team roles or null.
   */
  public function getTeamRoles() : ?array;

  /**
   * Sets the team roles of the invitation.
   *
   * @param \Drupal\apigee_edge_teams\Entity\TeamRoleInterface[] $team_roles
   *   An array of team roles.
   *
   * @return \Drupal\apigee_edge_teams\Entity\TeamInvitationInterface
   *   The invitation.
   */
  public function setTeamRoles(array $team_roles) : self;

  /**
   * Returns the status of the invitation.
   *
   * @return int
   *   The invitation status.
   */
  public function getStatus() : int;

  /**
   * Sets the status of the invitation.
   *
   * @param int $status
   *   The status.
   *
   * @return \Drupal\apigee_edge_teams\Entity\TeamInvitationInterface
   *   The invitation.
   */
  public function setStatus(int $status) : self;

  /**
   * Returns the recipient email for an invitation.
   *
   * @return string
   *   The recipient email.
   */
  public function getRecipient() : ?string;

  /**
   * Sets the recipient of the invitation.
   *
   * @param string $email
   *   The recipient email.
   *
   * @return \Drupal\apigee_edge_teams\Entity\TeamInvitationInterface
   *   The invitation.
   */
  public function setRecipient(string $email) : self;

  /**
   * Returns the creation date for an invitation.
   *
   * @return int
   *   Timestamp for the invitation creation date.
   */
  public function getCreatedTime() : int;

  /**
   * Sets the expiry time of the invitation.
   *
   * @param int $expiry_time
   *   The expiry time.
   *
   * @return \Drupal\apigee_edge_teams\Entity\TeamInvitationInterface
   *   The invitation.
   */
  public function setExpiryTime(int $expiry_time) : self;

  /**
   * Returns the expiry time for an invitation.
   *
   * @return int
   *   Timestamp for the invitation expiry date.
   */
  public function getExpiryTime() : int;

  /**
   * Returns TRUE if the invitation is expired.
   *
   * @return bool
   *   TRUE if expired. FALSE otherwise.
   */
  public function isExpired() : bool;

  /**
   * Returns TRUE if the invitation is pending.
   *
   * @return bool
   *   TRUE if pending. FALSE otherwise.
   */
  public function isPending() : bool;

  /**
   * Returns TRUE if the invitation is accepted.
   *
   * @return bool
   *   TRUE if accepted. FALSE otherwise.
   */
  public function isAccepted() : bool;

  /**
   * Returns TRUE if the invitation is declined.
   *
   * @return bool
   *   TRUE if declined. FALSE otherwise.
   */
  public function isDeclined() : bool;

}

Members

Name	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
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::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
EntityOwnerInterface::getOwner	public	function	Returns the entity owner's user entity.	1
EntityOwnerInterface::getOwnerId	public	function	Returns the entity owner's user ID.	1
EntityOwnerInterface::setOwner	public	function	Sets the entity owner's user entity.	1
EntityOwnerInterface::setOwnerId	public	function	Sets the entity owner's user ID.	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::toArray	public	function	Gets an array of all field values. Overrides EntityInterface::toArray
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
RevisionableInterface::getLoadedRevisionId	public	function	Gets the loaded Revision ID of the entity.	1
RevisionableInterface::getRevisionId	public	function	Gets the revision identifier of the entity.	1
RevisionableInterface::isDefaultRevision	public	function	Checks if this entity is the default revision.	1
RevisionableInterface::isLatestRevision	public	function	Checks if this entity is the latest revision.	1
RevisionableInterface::isNewRevision	public	function	Determines whether a new revision should be created on save.	1
RevisionableInterface::preSaveRevision	public	function	Acts on a revision before it gets saved.	1
RevisionableInterface::setNewRevision	public	function	Enforces an entity to be saved as a new revision.	1
RevisionableInterface::updateLoadedRevisionId	public	function	Updates the loaded Revision ID with the revision ID.	1
RevisionableInterface::wasDefaultRevision	public	function	Checks whether the entity object was a default revision when it was saved.	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
TeamInvitationInterface::getCreatedTime	public	function	Returns the creation date for an invitation.	1
TeamInvitationInterface::getExpiryTime	public	function	Returns the expiry time for an invitation.	1
TeamInvitationInterface::getLabel	public	function	Returns the label for this invitation.	1
TeamInvitationInterface::getRecipient	public	function	Returns the recipient email for an invitation.	1
TeamInvitationInterface::getStatus	public	function	Returns the status of the invitation.	1
TeamInvitationInterface::getTeam	public	function	Returns the team entity.	1
TeamInvitationInterface::getTeamRoles	public	function	Returns the team roles.	1
TeamInvitationInterface::isAccepted	public	function	Returns TRUE if the invitation is accepted.	1
TeamInvitationInterface::isDeclined	public	function	Returns TRUE if the invitation is declined.	1
TeamInvitationInterface::isExpired	public	function	Returns TRUE if the invitation is expired.	1
TeamInvitationInterface::isPending	public	function	Returns TRUE if the invitation is pending.	1
TeamInvitationInterface::setExpiryTime	public	function	Sets the expiry time of the invitation.	1
TeamInvitationInterface::setLabel	public	function	Sets the invitation label.	1
TeamInvitationInterface::setRecipient	public	function	Sets the recipient of the invitation.	1
TeamInvitationInterface::setStatus	public	function	Sets the status of the invitation.	1
TeamInvitationInterface::setTeam	public	function	Sets the team of the invitation.	1
TeamInvitationInterface::setTeamRoles	public	function	Sets the team roles of the invitation.	1
TeamInvitationInterface::STATUS_ACCEPTED		constant	Invitation is accepted.
TeamInvitationInterface::STATUS_DECLINED		constant	Invitation is declined.
TeamInvitationInterface::STATUS_EXPIRED		constant	Invitation is expired.
TeamInvitationInterface::STATUS_PENDING		constant	Invitation is sent and pending.
TranslatableInterface::addTranslation	public	function	Adds a new translation to the translatable object.	1
TranslatableInterface::getTranslation	public	function	Gets a translation of the data.	1
TranslatableInterface::getTranslationLanguages	public	function	Returns the languages the data is translated to.	1
TranslatableInterface::getUntranslated	public	function	Returns the translatable object referring to the original language.	1
TranslatableInterface::hasTranslation	public	function	Checks there is a translation for the given language code.	1
TranslatableInterface::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes.	1
TranslatableInterface::isDefaultTranslation	public	function	Checks whether the translation is the default one.	1
TranslatableInterface::isNewTranslation	public	function	Checks whether the translation is new.	1
TranslatableInterface::isTranslatable	public	function	Returns the translation support status.	1
TranslatableInterface::removeTranslation	public	function	Removes the translation identified by the given language code.	1
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly	public	function	Checks if untranslatable fields should affect only the default translation.	1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision	public	function	Checks whether this is the latest revision affecting this translation.	1
TranslatableRevisionableInterface::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision.	1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced	public	function	Checks if the revision translation affected flag value has been enforced.	1
TranslatableRevisionableInterface::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected.	1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced	public	function	Enforces the revision translation affected flag value.	1

You are here

interface TeamInvitationInterface in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation