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 JTwittersearch
+ Graphe d'héritage de JTwittersearch:

Fonctions membres publiques

 search ($query, $callback=null, $geocode=null, $lang=null, $locale=null, $result_type=null, $count=15, $until=null, $since_id=0, $max_id=0, $entities=null)
 
 getSavedSearches ()
 
 getSavedSearchesById ($id)
 
 createSavedSearch ($query)
 
 deleteSavedSearch ($id)
 
- 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 Search class for the Joomla Platform.

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

Documentation des fonctions membres

◆ createSavedSearch()

createSavedSearch (   $query)

Method to create a new saved search for the authenticated user.

Paramètres
string$queryThe query of the search the user would like to save.
Renvoie
array The decoded JSON response
Depuis
12.3

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

◆ deleteSavedSearch()

deleteSavedSearch (   $id)

Method to delete a saved search for the authenticating user.

Paramètres
integer$idThe ID of the saved search.
Renvoie
array The decoded JSON response
Depuis
12.3

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

◆ getSavedSearches()

getSavedSearches ( )

Method to get the authenticated user's saved search queries.

Renvoie
array The decoded JSON response
Depuis
12.3

Références $path.

◆ getSavedSearchesById()

getSavedSearchesById (   $id)

Method to get the information for the saved search represented by the given id.

Paramètres
integer$idThe ID of the saved search.
Renvoie
array The decoded JSON response
Depuis
12.3

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

◆ search()

search (   $query,
  $callback = null,
  $geocode = null,
  $lang = null,
  $locale = null,
  $result_type = null,
  $count = 15,
  $until = null,
  $since_id = 0,
  $max_id = 0,
  $entities = null 
)

Method to get tweets that match a specified query.

Paramètres
string$querySearch query. Should be URL encoded. Queries will be limited by complexity.
string$callbackIf supplied, the response will use the JSONP format with a callback of the given name
string$geocodeReturns tweets by users located within a given radius of the given latitude/longitude. The parameter value is specified by "latitude,longitude,radius", where radius units must be specified as either "mi" (miles) or "km" (kilometers).
string$langRestricts tweets to the given language, given by an ISO 639-1 code.
string$localeSpecify the language of the query you are sending (only ja is currently effective). This is intended for language-specific clients and the default should work in the majority of cases.
string$result_typeSpecifies what type of search results you would prefer to receive. The current default is "mixed."
integer$countThe number of tweets to return per page, up to a maximum of 100. Defaults to 15.
string$untilReturns tweets generated before the given date. Date should be formatted as YYYY-MM-DD.
integer$since_idReturns results with an ID greater than (that is, more recent than) the specified ID.
integer$max_idReturns results with an ID less than (that is, older than) or equal to the specified ID.
boolean$entitiesWhen set to either true, t or 1, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discrete structure, including: urls, media and hashtags.
Renvoie
array The decoded JSON response
Depuis
12.3

Références $count, $data, $lang, $path, et $query.


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