interface ApigeeEdgeManagementCliServiceInterface in Apigee Edge 8

Defines an interface for Edge connection classes.

Hierarchy

• interface \Drupal\apigee_edge\Command\Util\ApigeeEdgeManagementCliServiceInterface

2 files declare their use of ApigeeEdgeManagementCliServiceInterface

ApigeeEdgeManagementCliServiceTest.php in tests/src/Unit/Command/Util/ApigeeEdgeManagementCliServiceTest.php

CliService.php in src/CliService.php

File

src/Command/Util/ApigeeEdgeManagementCliServiceInterface.php, line 27

Namespace

Drupal\apigee_edge\Command\Util

interface ApigeeEdgeManagementCliServiceInterface {

  // Default role name to create in Apigee Edge.
  const DEFAULT_ROLE_NAME = 'drupalportal';

  /**
   * Create role in Apigee Edge for Drupal to use for Edge connection.
   *
   * @param \Symfony\Component\Console\Style\StyleInterface $io
   *   The IO interface of the CLI tool calling the method.
   * @param callable $t
   *   The translation function akin to t().
   * @param string $org
   *   The organization to connect to.
   * @param string $email
   *   The email of an Edge user with org admin role to make Edge API calls.
   * @param string $password
   *   The password of an Edge user with org admin role to make Edge API calls.
   * @param null|string $base_url
   *   The base url of the Edge API.
   * @param null|string $role_name
   *   The role name to add the permissions to.
   * @param null|bool $force
   *   Force running of permissions on a role that already exists.
   */
  public function createEdgeRoleForDrupal(StyleInterface $io, callable $t, string $org, string $email, string $password, ?string $base_url, ?string $role_name, bool $force);

}

Members

Name	Modifiers	Type	Description	Overrides
ApigeeEdgeManagementCliServiceInterface::createEdgeRoleForDrupal	public	function	Create role in Apigee Edge for Drupal to use for Edge connection.	1
ApigeeEdgeManagementCliServiceInterface::DEFAULT_ROLE_NAME		constant