Docs For Class JLinkedinOauth

Description

Joomla Platform class for generating Linkedin API access token.

since: 13.1

Located in /libraries/joomla/linkedin/oauth.php (line 20)

JOAuth1Client
   |
   --JLinkedinOauth

Variable Summary

JRegistry $options

Method Summary

JLinkedinOauth __construct ([JRegistry $options = null], [JHttp $client = null], [JInput $input = null])

string getScope ()

JLinkedinOauth setScope (mixed $scope)

void validateResponse (string $url, JHttpResponse $response)

boolean verifyCredentials ()

Variables

JRegistry $options (line 26)

var: Options for the JLinkedinOauth object.
since: 13.1
access: protected

Redefinition of:

JOAuth1Client::$options

Inherited Variables

Inherited from JOAuth1Client

JOAuth1Client::$application
JOAuth1Client::$client
JOAuth1Client::$input
JOAuth1Client::$token
JOAuth1Client::$version

Methods

Constructor __construct (line 37)

Constructor.

since: 13.1
access: public

JLinkedinOauth __construct ([JRegistry $options = null], [JHttp $client = null], [JInput $input = null])

JRegistry $options: JLinkedinOauth options object.
JHttp $client: The HTTP client object.
JInput $input: The input object

Redefinition of:

JOAuth1Client::__construct(): Constructor.

getScope (line 140)

Method to get the current scope

return: String or an array of string containing permissions.
since: 13.1
access: public

string getScope ()

setScope (line 126)

Method used to set permissions.

return: This object for method chaining
see: https://developer.linkedin.com/documents/authentication
since: 13.1
access: public

JLinkedinOauth setScope (mixed $scope)

mixed $scope: String or an array of string containing permissions.

validateResponse (line 96)

Method to validate a response.

since: 13.1
throws: DomainException
access: public

void validateResponse (string $url, JHttpResponse $response)

string $url: The request URL.
JHttpResponse $response: The response to validate.

Redefinition of:

JOAuth1Client::validateResponse(): Method to validate a response.

verifyCredentials (line 57)

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

return: Returns true if the access token is valid and false otherwise.
since: 13.1
access: public

boolean verifyCredentials ()

Redefinition of:

JOAuth1Client::verifyCredentials(): Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not.

Inherited Methods

Inherited From JOAuth1Client

JOAuth1Client::__construct()
JOAuth1Client::authenticate()
JOAuth1Client::generateNonce()
JOAuth1Client::getOption()
JOAuth1Client::getToken()
JOAuth1Client::oauthRequest()
JOAuth1Client::safeEncode()
JOAuth1Client::setOption()
JOAuth1Client::setToken()
JOAuth1Client::toUrl()
JOAuth1Client::validateResponse()
JOAuth1Client::verifyCredentials()