OAuth2ManagerInterface.php in Social Auth 8

Namespace

Drupal\social_auth\AuthManager

File

src/AuthManager/OAuth2ManagerInterface.php

<?php

namespace Drupal\social_auth\AuthManager;


/**
 * Defines an OAuth2Manager Interface.
 *
 * @package Drupal\social_auth\AuthManager
 */
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);

}

Interfaces

Name	Description
OAuth2ManagerInterface	Defines an OAuth2Manager Interface.