Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques
Référence de la classe JTwitterFriends
+ Graphe d'héritage de JTwitterFriends:
+ Graphe de collaboration de JTwitterFriends:

Liste de tous les membres

Fonctions membres publiques

 getFriendIds ($user, $cursor=null, $string_ids=null, $count=0)
 getFriendshipDetails ($user_a, $user_b)
 getFollowerIds ($user, $cursor=null, $string_ids=null, $count=0)
 getFriendshipsIncoming ($cursor=null, $string_ids=null)
 getFriendshipsOutgoing ($cursor=null, $string_ids=null)
 follow ($user, $follow=false)
 unfollow ($user)
 getFriendshipsLookup ($screen_name=null, $id=null)
 updateFriendship ($user, $device=null, $retweets=null)
 getFriendshipNoRetweetIds ($string_ids=null)
- Fonctions membres publiques inherited from JTwitterObject
 __construct (JRegistry &$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)

Additional Inherited Members

- Attributs protégés inherited from JTwitterObject
 $options
 $client
 $oauth

Description détaillée

Définition à la ligne 19 du fichier friends.php.

Documentation des fonctions membres

JTwitterFriends::follow (   $user,
  $follow = false 
)

Allows the authenticating users to follow the user specified in the ID parameter.

Paramètres:
mixed$userEither an integer containing the user ID or a string containing the screen name.
boolean$followEnable notifications for the target user.
Renvoie:
array The decoded JSON response
Depuis:
12.3
Exceptions:
RuntimeException

Définition à la ligne 281 du fichier friends.php.

{
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the correct format; must use integer or string');
}
// Check if follow is true
if ($follow)
{
$data['follow'] = $follow;
}
// Set the API path
$path = '/friendships/create.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
JTwitterFriends::getFollowerIds (   $user,
  $cursor = null,
  $string_ids = null,
  $count = 0 
)

Method to get an array of user IDs the specified user is followed by.

Paramètres:
mixed$userEither an integer containing the user ID or a string containing the screen name.
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."
boolean$string_idsSet to true to return IDs as strings, false to return as integers.
integer$countSpecifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request.
Renvoie:
array The decoded JSON response
Depuis:
12.3
Exceptions:
RuntimeException

Définition à la ligne 149 du fichier friends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('followers', 'ids');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the correct format; must use integer or string');
}
// Set the API path
$path = '/followers/ids.json';
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if string_ids is specified
if (!is_null($string_ids))
{
$data['stringify_ids'] = $string_ids;
}
// Check if count is specified
if (!is_null($count))
{
$data['count'] = $count;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
JTwitterFriends::getFriendIds (   $user,
  $cursor = null,
  $string_ids = null,
  $count = 0 
)

Method to get an array of user IDs the specified user follows.

Paramètres:
mixed$userEither an integer containing the user ID or a string containing the screen name.
integer$cursorCauses the list of connections 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."
boolean$string_idsSet to true to return IDs as strings, false to return as integers.
integer$countSpecifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request.
Renvoie:
array The decoded JSON response
Depuis:
12.3
Exceptions:
RuntimeException

Définition à la ligne 36 du fichier friends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('friends', 'ids');
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the correct format; must use integer or string');
}
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if string_ids is true
if ($string_ids)
{
$data['stringify_ids'] = $string_ids;
}
// Check if count is specified
if ($count > 0)
{
$data['count'] = $count;
}
// Set the API path
$path = '/friends/ids.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
JTwitterFriends::getFriendshipDetails (   $user_a,
  $user_b 
)

Method to display detailed friend information between two users.

Paramètres:
mixed$user_aEither an integer containing the user ID or a string containing the screen name of the first user.
mixed$user_bEither an integer containing the user ID or a string containing the screen name of the second user.
Renvoie:
array The decoded JSON response
Depuis:
12.3
Exceptions:
RuntimeException

Définition à la ligne 92 du fichier friends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'show');
// Determine which type of data was passed for $user_a
if (is_numeric($user_a))
{
$data['source_id'] = $user_a;
}
elseif (is_string($user_a))
{
$data['source_screen_name'] = $user_a;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The first specified username is not in the correct format; must use integer or string');
}
// Determine which type of data was passed for $user_b
if (is_numeric($user_b))
{
$data['target_id'] = $user_b;
}
elseif (is_string($user_b))
{
$data['target_screen_name'] = $user_b;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The second specified username is not in the correct format; must use integer or string');
}
// Set the API path
$path = '/friendships/show.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
JTwitterFriends::getFriendshipNoRetweetIds (   $string_ids = null)

Method to get the user ids that currently authenticated user does not want to see retweets from.

Paramètres:
boolean$string_idsSet to true to return IDs as strings, false to return as integers.
Renvoie:
array The decoded JSON response
Depuis:
12.3

Définition à la ligne 440 du fichier friends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'no_retweets/ids');
$data = array();
// Check if string_ids is specified
if (!is_null($string_ids))
{
$data['stringify_ids'] = $string_ids;
}
// Set the API path
$path = '/friendships/no_retweets/ids.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
JTwitterFriends::getFriendshipsIncoming (   $cursor = null,
  $string_ids = null 
)

Method to determine pending requests to follow the authenticating user.

Paramètres:
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."
boolean$string_idsSet to true to return IDs as strings, false to return as integers.
Renvoie:
array The decoded JSON response
Depuis:
12.3

Définition à la ligne 206 du fichier friends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'incoming');
$data = array();
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if string_ids is specified
if (!is_null($string_ids))
{
$data['stringify_ids'] = $string_ids;
}
// Set the API path
$path = '/friendships/incoming.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
JTwitterFriends::getFriendshipsLookup (   $screen_name = null,
  $id = null 
)

Method to get the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided.

Paramètres:
string$screen_nameA 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.
Renvoie:
array The decoded JSON response
Depuis:
12.3
Exceptions:
RuntimeException

Définition à la ligne 356 du fichier friends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'lookup');
// Set user IDs and screen names.
if ($id)
{
$data['user_id'] = $id;
}
if ($screen_name)
{
$data['screen_name'] = $screen_name;
}
if ($id == null && $screen_name == null)
{
// We don't have a valid entry
throw new RuntimeException('You must specify either a comma separated list of screen names, user IDs, or a combination of the two');
}
// Set the API path
$path = '/friendships/lookup.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
JTwitterFriends::getFriendshipsOutgoing (   $cursor = null,
  $string_ids = null 
)

Method to determine every protected user for whom the authenticating user has a pending follow request.

Paramètres:
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."
boolean$string_idsSet to true to return IDs as strings, false to return as integers.
Renvoie:
array The decoded JSON response
Depuis:
12.3

Définition à la ligne 244 du fichier friends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('friendships', 'outgoing');
$data = array();
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if string_ids is specified
if (!is_null($string_ids))
{
$data['stringify_ids'] = $string_ids;
}
// Set the API path
$path = '/friendships/outgoing.json';
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
JTwitterFriends::unfollow (   $user)

Allows the authenticating users to unfollow the user specified in the ID parameter.

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

Définition à la ligne 321 du fichier friends.php.

{
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the correct format; must use integer or string');
}
// Set the API path
$path = '/friendships/destroy.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
JTwitterFriends::updateFriendship (   $user,
  $device = null,
  $retweets = null 
)

Allows one to enable or disable retweets and device notifications from the specified user.

Paramètres:
mixed$userEither an integer containing the user ID or a string containing the screen name.
boolean$deviceEnable/disable device notifications from the target user.
boolean$retweetsEnable/disable retweets from the target user.
Renvoie:
array The decoded JSON response
Depuis:
12.3
Exceptions:
RuntimeException

Définition à la ligne 395 du fichier friends.php.

{
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the correct format; must use integer or string');
}
// Check if device is specified.
if (!is_null($device))
{
$data['device'] = $device;
}
// Check if retweets is specified.
if (!is_null($retweets))
{
$data['retweets'] = $retweets;
}
// Set the API path
$path = '/friendships/update.json';
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
La documentation de cette classe a été générée à partir du fichier suivant :