You are here

interface OAuth2ManagerInterface in Social Auth 8

Same name and namespace in other branches
  1. 8.2 src/AuthManager/OAuth2ManagerInterface.php \Drupal\social_auth\AuthManager\OAuth2ManagerInterface
  2. 3.x src/AuthManager/OAuth2ManagerInterface.php \Drupal\social_auth\AuthManager\OAuth2ManagerInterface

Defines an OAuth2Manager Interface.

@package Drupal\social_auth\AuthManager

Hierarchy

Expanded class hierarchy of OAuth2ManagerInterface

All classes that implement OAuth2ManagerInterface

File

src/AuthManager/OAuth2ManagerInterface.php, line 10

Namespace

Drupal\social_auth\AuthManager
View source
interface OAuth2ManagerInterface {

  /**
   * Sets the service client.
   *
   * @param mixed $client
   *   The service client.
   *
   * @return $this
   *   The current object.
   */
  public function setClient($client);

  /**
   * Gets the service client object.
   *
   * @return mixed
   *   The service client object.
   */
  public function getClient();

  /**
   * Authenticates the users by using the access token.
   *
   * @return $this
   *   The current object.
   */
  public function authenticate();

  /**
   * Gets the access token after authentication.
   *
   * @return mixed
   *   The access token.
   */
  public function getAccessToken();

  /**
   * Sets the default access token.
   *
   * @param mixed $access_token
   *   The access token.
   *
   * @return $this
   *   The current object.
   */
  public function setAccessToken($access_token);

}

Members

Namesort descending Modifiers Type Description Overrides
OAuth2ManagerInterface::authenticate public function Authenticates the users by using the access token.
OAuth2ManagerInterface::getAccessToken public function Gets the access token after authentication. 1
OAuth2ManagerInterface::getClient public function Gets the service client object. 1
OAuth2ManagerInterface::setAccessToken public function Sets the default access token. 1
OAuth2ManagerInterface::setClient public function Sets the service client. 1