Class JTwittersearch

Description

Twitter API Search class for the Joomla Platform.

  • since: 12.3

Located in /libraries/joomla/twitter/search.php (line 19)

JTwitterObject
   |
   --JTwittersearch
Method Summary
 array createSavedSearch (string $query)
 array deleteSavedSearch (integer $id)
 array getSavedSearches ()
 array getSavedSearchesById (integer $id)
 array search (string $query, [string $callback = null], [string $geocode = null], [string $lang = null], [string $locale = null], [string $result_type = null], [integer $count = 15], [string $until = null], [integer $since_id = 0], [integer $max_id = 0], [boolean $entities = null])
Variables
Methods
createSavedSearch (line 168)

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

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array createSavedSearch (string $query)
  • string $query: The query of the search the user would like to save.
deleteSavedSearch (line 189)

Method to delete a saved search for the authenticating user.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array deleteSavedSearch (integer $id)
  • integer $id: The ID of the saved search.
getSavedSearches (line 126)

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

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getSavedSearches ()
getSavedSearchesById (line 147)

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

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getSavedSearchesById (integer $id)
  • integer $id: The ID of the saved search.
search (line 43)

Method to get tweets that match a specified query.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array search (string $query, [string $callback = null], [string $geocode = null], [string $lang = null], [string $locale = null], [string $result_type = null], [integer $count = 15], [string $until = null], [integer $since_id = 0], [integer $max_id = 0], [boolean $entities = null])
  • string $query: Search query. Should be URL encoded. Queries will be limited by complexity.
  • string $callback: If supplied, the response will use the JSONP format with a callback of the given name
  • string $geocode: Returns 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 $lang: Restricts tweets to the given language, given by an ISO 639-1 code.
  • string $locale: Specify 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_type: Specifies what type of search results you would prefer to receive. The current default is "mixed."
  • integer $count: The number of tweets to return per page, up to a maximum of 100. Defaults to 15.
  • string $until: Returns tweets generated before the given date. Date should be formatted as YYYY-MM-DD.
  • integer $since_id: Returns results with an ID greater than (that is, more recent than) the specified ID.
  • integer $max_id: Returns results with an ID less than (that is, older than) or equal to the specified ID.
  • boolean $entities: When 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.

Inherited Methods

Inherited From JTwitterObject

 JTwitterObject::__construct()
 JTwitterObject::checkRateLimit()
 JTwitterObject::fetchUrl()
 JTwitterObject::getOption()
 JTwitterObject::getRateLimit()
 JTwitterObject::sendRequest()
 JTwitterObject::setOption()

Documentation generated on Tue, 19 Nov 2013 15:12:39 +0100 by phpDocumentor 1.4.3