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

Fonctions membres publiques

 getUsersLookup ($screenName=null, $id=null, $entities=null)
 
 getUserProfileBanner ($user)
 
 searchUsers ($query, $page=0, $count=0, $entities=null)
 
 getUser ($user, $entities=null)
 
 getContributees ($user, $entities=null, $skipStatus=null)
 
 getContributors ($user, $entities=null, $skipStatus=null)
 
 getSuggestions ($lang=null)
 
 getSuggestionsSlug ($slug, $lang=null)
 
 getSuggestionsSlugMembers ($slug)
 
- 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 Users 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

◆ getContributees()

getContributees (   $user,
  $entities = null,
  $skipStatus = null 
)

Method to get an array of users that the specified user can contribute to.

Paramètres
mixed$userEither an integer containing the user ID or a string containing the screen name.
boolean$entitiesSet to true to return IDs as strings, false to return as integers.
boolean$skipStatusWhen set to either true, t or 1 statuses will not be included in the returned user objects.
Renvoie
array The decoded JSON response
Depuis
3.1.4
Exceptions
RuntimeException

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

◆ getContributors()

getContributors (   $user,
  $entities = null,
  $skipStatus = null 
)

Method to get an array of users who can contribute to the specified account.

Paramètres
mixed$userEither an integer containing the user ID or a string containing the screen name.
boolean$entitiesSet to true to return IDs as strings, false to return as integers.
boolean$skipStatusWhen set to either true, t or 1 statuses will not be included in the returned user objects.
Renvoie
array The decoded JSON response
Depuis
3.1.4
Exceptions
RuntimeException

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

◆ getSuggestions()

getSuggestions (   $lang = null)

Method access to Twitter's suggested user list.

Paramètres
boolean$langRestricts the suggested categories to the requested language.
Renvoie
array The decoded JSON response
Depuis
3.1.4

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

◆ getSuggestionsSlug()

getSuggestionsSlug (   $slug,
  $lang = null 
)

method to access the users in a given category of the Twitter suggested user list.

Paramètres
string$slugThe short name of list or a category.
boolean$langRestricts the suggested categories to the requested language.
Renvoie
array The decoded JSON response
Depuis
3.1.4

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

◆ getSuggestionsSlugMembers()

getSuggestionsSlugMembers (   $slug)

Method to access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.

Paramètres
string$slugThe short name of list or a category.
Renvoie
array The decoded JSON response
Depuis
3.1.4

Références $path.

◆ getUser()

getUser (   $user,
  $entities = null 
)

Method to get extended information of a given user, specified by ID or screen name as per the required id parameter.

Paramètres
mixed$userEither an integer containing the user ID or a string containing the screen name.
boolean$entitiesSet to true to return IDs as strings, false to return as integers.
Renvoie
array The decoded JSON response
Depuis
3.1.4
Exceptions
RuntimeException

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

◆ getUserProfileBanner()

getUserProfileBanner (   $user)

Method to access the profile banner in various sizes for the user with the indicated screen_name.

Paramètres
mixed$userEither an integer containing the user ID or a string containing the screen name.
Renvoie
array The decoded JSON response
Depuis
3.1.4

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

◆ getUsersLookup()

getUsersLookup (   $screenName = null,
  $id = null,
  $entities = null 
)

Method to get up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two.

Paramètres
string$screenNameA comma separated list of screen names, up to 100 are allowed in a single request.
string$idA comma separated list of user IDs, up to 100 are allowed in a single request.
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 discreet structure, including: user_mentions, urls, and hashtags.
Renvoie
array The decoded JSON response
Depuis
3.1.4
Exceptions
RuntimeException

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

◆ searchUsers()

searchUsers (   $query,
  $page = 0,
  $count = 0,
  $entities = null 
)

Method used to search for users

Paramètres
string$queryThe search query to run against people search.
integer$pageSpecifies the page of results to retrieve.
integer$countThe number of people to retrieve. Maximum of 20 allowed per page.
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 discreet structure, including: user_mentions, urls, and hashtags.
Renvoie
array The decoded JSON response
Depuis
3.1.4
Exceptions
RuntimeException

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

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