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

Fonctions membres publiques

 getBlocking ($stringifyIds=null, $cursor=null)
 
 block ($user, $entities=null, $skipStatus=null)
 
 unblock ($user, $entities=null, $skipStatus=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 Block 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

◆ block()

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

Method to block the specified user from following the authenticating user.

Paramètres
mixed$userEither an integer containing the user ID or a string containing the screen name.
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.
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.

◆ getBlocking()

getBlocking (   $stringifyIds = null,
  $cursor = null 
)

Method to get the user ids the authenticating user is blocking.

Paramètres
boolean$stringifyIdsProvide this option to have ids returned as strings instead.
integer$cursorCauses the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first "page."
Renvoie
array The decoded JSON response
Depuis
3.1.4

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

◆ unblock()

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

Method to unblock the specified user from following the authenticating user.

Paramètres
mixed$userEither an integer containing the user ID or a string containing the screen name.
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.
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.


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