Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JTwitterFavorites
+ Graphe d'héritage de JTwitterFavorites:

Fonctions membres publiques

 getFavorites ($user=null, $count=20, $sinceId=0, $maxId=0, $entities=null)
 
 createFavorites ($id, $entities=null)
 
 deleteFavorites ($id, $entities=null)
 
- Fonctions membres publiques hérités de JTwitterObject
 __construct (Registry &$options=null, JHttp $client=null, JTwitterOAuth $oauth=null)
 
 checkRateLimit ($resource=null, $action=null)
 
 fetchUrl ($path, $parameters=null)
 
 getRateLimit ($resource)
 
 sendRequest ($path, $method='GET', $data=array(), $headers=array())
 
 getOption ($key)
 
 setOption ($key, $value)
 

Membres hérités additionnels

- Attributs protégés hérités de JTwitterObject
 $options
 
 $client
 
 $oauth
 

Description détaillée

Twitter API Favorites class for the Joomla Platform.

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

Documentation des fonctions membres

◆ createFavorites()

createFavorites (   $id,
  $entities = null 
)

Method to favorite the status specified in the ID parameter as the authenticating user

Paramètres
integer$idThe numerical ID of the desired status.
boolean$entitiesWhen set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $data, $id, et $path.

◆ deleteFavorites()

deleteFavorites (   $id,
  $entities = null 
)

Method to un-favorites the status specified in the ID parameter as the authenticating user.

Paramètres
integer$idThe numerical ID of the desired status.
boolean$entitiesWhen set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $data, $id, et $path.

◆ getFavorites()

getFavorites (   $user = null,
  $count = 20,
  $sinceId = 0,
  $maxId = 0,
  $entities = null 
)

Method to get the most recent favorite statuses for the authenticating or specified user.

Paramètres
mixed$userEither an integer containing the user ID or a string containing the screen name.
integer$countSpecifies the number of tweets to try and retrieve, up to a maximum of 200. Retweets are always included in the count, so it is always suggested to set $includeRts to true
integer$sinceIdReturns results with an ID greater than (that is, more recent than) the specified ID.
integer$maxIdReturns results with an ID less than (that is, older than) the specified ID.
boolean$entitiesWhen set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $count, $data, $path, $user, et elseif.


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