Class JTwittersearch
Twitter API Search class for the Joomla Platform.
-
JTwitterObject
-
JTwittersearch
Methods summary
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 )
Method to get tweets that match a specified query.
Method to get tweets that match a specified query.
Parameters
- $query
string - $query Search query. Should be URL encoded. Queries will be limited by
complexity.- $callback
string - $callback If supplied, the response will use the JSONP format with a callback of
the given name- $geocode
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).- $lang
string - $lang Restricts tweets to the given language, given by an ISO 639-1 code.- $locale
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.- $result_type
string - $result_type Specifies what type of search results you would prefer to receive.
The current default is "mixed."- $count
integer - $count The number of tweets to return per page, up to a maximum of 100. Defaults
to 15.- $until
string - $until Returns tweets generated before the given date. Date should be formatted
as YYYY-MM-DD.- $since_id
integer - $since_id Returns results with an ID greater than (that is, more recent than)
the specified ID.- $max_id
integer - $max_id Returns results with an ID less than (that is, older than) or equal to
the specified ID.- $entities
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. Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
getSavedSearches( )
Method to get the authenticated user's saved search queries.
Method to get the authenticated user's saved search queries.
Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
getSavedSearchesById( integer $id )
Method to get the information for the saved search represented by the given
id.
Method to get the information for the saved search represented by the given
id.
Parameters
- $id
integer - $id The ID of the saved search. Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
createSavedSearch( string $query )
Method to create a new saved search for the authenticated user.
Method to create a new saved search for the authenticated user.
Parameters
- $query
string - $query The query of the search the user would like to save. Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
deleteSavedSearch( integer $id )
Method to delete a saved search for the authenticating user.
Method to delete a saved search for the authenticating user.
Parameters
- $id
integer - $id The ID of the saved search. Returns
array - The decoded JSON response
Since
12.3
|
__construct(),
checkRateLimit(),
fetchUrl(),
getOption(),
getRateLimit(),
sendRequest(),
setOption()
Magic methods summary
Properties summary
$client,
$oauth,
$options
