interface TeamMembershipManagerInterface in Apigee Edge 8

Base definition of the team membership manager service.

This service make easier to retrieve and update company (team) and developer membership information. Hides the complexity of the company members API that we did not hide in the SDK.

Hierarchy

• interface \Drupal\apigee_edge_teams\TeamMembershipManagerInterface

12 files declare their use of TeamMembershipManagerInterface

AddTeamMembersForm.php in modules/apigee_edge_teams/src/Form/AddTeamMembersForm.php

ManageTeamMembersAccess.php in modules/apigee_edge_teams/src/Access/ManageTeamMembersAccess.php

RemoveTeamMemberForm.php in modules/apigee_edge_teams/src/Form/RemoveTeamMemberForm.php

TeamAppFormTrait.php in modules/apigee_edge_teams/src/Entity/Form/TeamAppFormTrait.php

TeamContextSwitcherBlock.php in modules/apigee_edge_teams/src/Plugin/Block/TeamContextSwitcherBlock.php

... See full list

File

modules/apigee_edge_teams/src/TeamMembershipManagerInterface.php, line 30

Namespace

Drupal\apigee_edge_teams

interface TeamMembershipManagerInterface {

  /**
   * Returns members of a team.
   *
   * @param string $team
   *   Name of a team.
   *
   * @return string[]
   *   Array of developer email addresses.
   */
  public function getMembers(string $team) : array;

  /**
   * Adds members to a team.
   *
   * @param string $team
   *   Name of a team.
   * @param array $developers
   *   Array of developer email addresses.
   */
  public function addMembers(string $team, array $developers) : void;

  /**
   * Removes members from a team.
   *
   * @param string $team
   *   Name of a team.
   * @param array $developers
   *   Array of developer email addresses.
   */
  public function removeMembers(string $team, array $developers) : void;

  /**
   * Returns the list of teams where the developer is currently a member.
   *
   * @param string $developer
   *   Developer email address.
   *
   * @return string[]
   *   Array of team names.
   *
   * @throws \Drupal\apigee_edge\Exception\DeveloperDoesNotExistException
   *   If developer not found with id.
   */
  public function getTeams(string $developer) : array;

}

Members

Name	Modifiers	Type	Description	Overrides
TeamMembershipManagerInterface::addMembers	public	function	Adds members to a team.	2
TeamMembershipManagerInterface::getMembers	public	function	Returns members of a team.	2
TeamMembershipManagerInterface::getTeams	public	function	Returns the list of teams where the developer is currently a member.	2
TeamMembershipManagerInterface::removeMembers	public	function	Removes members from a team.	2