interface OAuth2ManagerInterface in Social API 3.x

Defines an OAuth2Manager Interface.

@package Drupal\social_api\OAuth2Manager

Hierarchy

• interface \Drupal\social_api\AuthManager\OAuth2ManagerInterface

File

src/AuthManager/OAuth2ManagerInterface.php, line 10

Namespace

Drupal\social_api\AuthManager

interface OAuth2ManagerInterface {

  /**
   * Authenticates the user.
   */
  public function authenticate();

  /**
   * Sets the provider 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();

  /**
   * Gets the access token after authentication.
   *
   * @return \League\OAuth2\Client\Token\AccessToken|mixed
   *   The access token.
   */
  public function getAccessToken();

  /**
   * Sets the access token.
   *
   * @param \League\OAuth2\Client\Token\AccessToken|mixed $access_token
   *   The access token.
   *
   * @return $this
   *   The current object.
   */
  public function setAccessToken($access_token);

  /**
   * Returns the authorization URL where user will be redirected.
   *
   * @return string|mixed
   *   Absolute authorization URL.
   */
  public function getAuthorizationUrl();

  /**
   * Returns OAuth2 state.
   *
   * @return string
   *   The OAuth2 state.
   */
  public function getState();

  /**
   * Gets data about the user.
   *
   * @return \League\OAuth2\Client\Provider\GenericResourceOwner|array|mixed
   *   User info returned by provider.
   */
  public function getUserInfo();

}

Members

Name	Modifiers	Type	Description	Overrides
OAuth2ManagerInterface::authenticate	public	function	Authenticates the user.
OAuth2ManagerInterface::getAccessToken	public	function	Gets the access token after authentication.	1
OAuth2ManagerInterface::getAuthorizationUrl	public	function	Returns the authorization URL where user will be redirected.
OAuth2ManagerInterface::getClient	public	function	Gets the service client object.	1
OAuth2ManagerInterface::getState	public	function	Returns OAuth2 state.
OAuth2ManagerInterface::getUserInfo	public	function	Gets data about the user.
OAuth2ManagerInterface::setAccessToken	public	function	Sets the access token.	1
OAuth2ManagerInterface::setClient	public	function	Sets the provider client.	1