View file phpBB3/vendor/carlos-mg89/oauth/src/OAuth/OAuth2/Service/ServiceInterface.php

File size: 1.04Kb
<?php

namespace OAuth\OAuth2\Service;

use OAuth\Common\Service\ServiceInterface as BaseServiceInterface;
use OAuth\Common\Token\TokenInterface;

/**
 * Defines the common methods across OAuth 2 services.
 */
interface ServiceInterface extends BaseServiceInterface
{
    /**
     * Authorization methods for various services.
     */
    const AUTHORIZATION_METHOD_HEADER_OAUTH = 0;
    const AUTHORIZATION_METHOD_HEADER_BEARER = 1;
    const AUTHORIZATION_METHOD_QUERY_STRING = 2;
    const AUTHORIZATION_METHOD_QUERY_STRING_V2 = 3;
    const AUTHORIZATION_METHOD_QUERY_STRING_V3 = 4;
    const AUTHORIZATION_METHOD_QUERY_STRING_V4 = 5;
    const AUTHORIZATION_METHOD_HEADER_TOKEN = 6;
    const AUTHORIZATION_METHOD_QUERY_STRING_V5 = 7;
    

    /**
     * Retrieves and stores/returns the OAuth2 access token after a successful authorization.
     *
     * @param string $code the access code from the callback
     * @param string $state
     *
     * @return TokenInterface $token
     */
    public function requestAccessToken($code, $state = null);
}