Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JTwitterOAuth
+ Graphe d'héritage de JTwitterOAuth:

Fonctions membres publiques

 __construct (Registry $options=null, JHttp $client=null, JInput $input=null, JApplicationWeb $application=null)
 
 verifyCredentials ()
 
 endSession ()
 
 validateResponse ($url, $response)
 
- Fonctions membres publiques hérités de JOAuth1Client
 __construct (Registry $options=null, JHttp $client=null, JInput $input=null, JApplicationWeb $application=null, $version=null)
 
 authenticate ()
 
 oauthRequest ($url, $method, $parameters, $data=array(), $headers=array())
 
 validateResponse ($url, $response)
 
 toUrl ($url, $parameters)
 
 safeEncode ($data)
 
 verifyCredentials ()
 
 getOption ($key)
 
 setOption ($key, $value)
 
 getToken ()
 
 setToken ($token)
 

Attributs protégés

 $options
 
- Attributs protégés hérités de JOAuth1Client
 $options
 
 $token = array()
 
 $client
 
 $input
 
 $application
 
 $version
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de JOAuth1Client
static generateNonce ()
 

Description détaillée

Joomla Platform class for generating Twitter API access token.

Depuis
12.3
Obsolète:
4.0 Use the joomla/twitter package via Composer instead

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Registry  $options = null,
JHttp  $client = null,
JInput  $input = null,
JApplicationWeb  $application = null 
)

Constructor.

Paramètres
Registry$optionsJTwitterOauth options object.
JHttp$clientThe HTTP client object.
JInput$inputThe input object.
JApplicationWeb$applicationThe application object.
Depuis
12.3

Références $client, $input, $options, et Registry\def().

Documentation des fonctions membres

◆ endSession()

endSession ( )

Ends the session of the authenticating user, returning a null cookie.

Renvoie
array The decoded JSON response
Depuis
12.3

Références $parameters, et $path.

◆ validateResponse()

validateResponse (   $url,
  $response 
)

Method to validate a response.

Paramètres
string$urlThe request URL.
JHttpResponse$responseThe response to validate.
Renvoie
void
Depuis
12.3
Exceptions
DomainException

Références $url, et code.

◆ verifyCredentials()

verifyCredentials ( )

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

Renvoie
boolean Returns true if the access token is valid and false otherwise.
Depuis
12.3

Références $parameters, et $path.

Documentation des champs

◆ $options

$options
protected

La documentation de cette classe a été générée à partir du fichier suivant :