\JOAuth2Client

Joomla Platform class for interacting with an OAuth 2.0 server.

Synopsis

class JOAuth2Client {

• // members
• protected JRegistry  $options;
• protected JHttp  $http;
• protected JInput  $input;
• protected JApplicationWeb  $application;
• // methods
• public void __construct()
• public string authenticate()
• public boolean isAuthenticated()
• public JHttpResponse createUrl()
• public string query()
• public mixed getOption()
• public JOAuth2Client setOption()
• public array getToken()
• public JOAuth2Client setToken()
• public array refreshToken()
}


Hierarchy

Extended by

• JFacebookOAuth

Members

protected

• $application — JApplicationWeb
• $http — JHttp
• $input — JInput
• $options — JRegistry

Methods

public

• __construct() — Constructor.
• authenticate() — Get the access token or redict to the authentication URL.
• createUrl() — Create the URL for authentication.
• getOption() — Get an option from the JOAuth2Client instance.
• getToken() — Get the access token from the JOAuth2Client instance.
• isAuthenticated() — Verify if the client has been authenticated
• query() — Send a signed Oauth request.
• refreshToken() — Refresh the access token instance.
• setOption() — Set an option for the JOAuth2Client instance.
• setToken() — Set an option for the JOAuth2Client instance.