OAuth

Extends \Joomla\OAuth1\Client

Joomla Framework class for generating Linkedin API access token.

deprecated
since

1.0

deprecated

The joomla/linkedin package is deprecated

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options, \Joomla\Http\Http $client, \Joomla\Input\Input $input, \Joomla\Application\AbstractWebApplication $application) 
since

1.0

Arguments

$options

\Joomla\Registry\RegistryOAuth options object.

$client

\Joomla\Http\HttpThe HTTP client object.

$input

\Joomla\Input\InputThe Input object

$application

\Joomla\Application\AbstractWebApplicationThe application object.

getScope

Method to get the current scope

getScope() : string
since

1.0

Response

stringString or an array of string containing permissions.

setScope

Method used to set permissions.

setScope(mixed $scope) : \Joomla\Linkedin\OAuth
see

https://developer.linkedin.com/documents/authentication

since

1.0

Arguments

$scope

mixedString or an array of string containing permissions.

Response

\Joomla\Linkedin\OAuthThis object for method chaining

validateResponse

Method to validate a response.

validateResponse(string $url, \Joomla\Http\Response $response) : void
since

1.0

throws

\DomainException

Arguments

$url

stringThe request URL.

$response

\Joomla\Http\ResponseThe response to validate.

verifyCredentials

Method to verify if the access token is valid by making a request to an API endpoint.

verifyCredentials() : boolean
since

1.0

Response

booleanReturns true if the access token is valid and false otherwise.

Properties

options

Options for the \Joomla\Linkedin\OAuth object.

since

1.0

Type(s)

\Joomla\Registry\Registry