Graphe d'héritage de JTwitterLists:

Fonctions membres publiques
	getLists ($user, $reverse=null)

	getStatuses ($list, $owner=null, $sinceId=0, $maxId=0, $count=0, $entities=null, $includeRts=null)

	getSubscribers ($list, $owner=null, $cursor=null, $entities=null, $skipStatus=null)

	deleteMembers ($list, $userId=null, $screenName=null, $owner=null)

	subscribe ($list, $owner=null)

	isMember ($list, $user, $owner=null, $entities=null, $skipStatus=null)

	isSubscriber ($list, $user, $owner=null, $entities=null, $skipStatus=null)

	unsubscribe ($list, $owner=null)

	addMembers ($list, $userId=null, $screenName=null, $owner=null)

	getMembers ($list, $owner=null, $entities=null, $skipStatus=null)

	getListById ($list, $owner=null)

	getSubscriptions ($user, $count=0, $cursor=null)

	update ($list, $owner=null, $name=null, $mode=null, $description=null)

	create ($name, $mode=null, $description=null)

	delete ($list, $owner=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 Lists 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

◆ addMembers()

addMembers	(	$list,
		$userId = `null`,
		$screenName = `null`,
		$owner = `null`
	)

Method to add multiple members to a list, by specifying a comma-separated list of member ids or screen names.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
string	$userId	A comma separated list of user IDs, up to 100 are allowed in a single request.
string	$screenName	A comma separated list of screen names, up to 100 are allowed in a single request.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name of the owner.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

Références $data, $list, $path, $userId, elseif, et null.

◆ create()

create	(	$name,
		$mode = `null`,
		$description = `null`
	)

Method to create a new list for the authenticated user.

Paramètres

string	$name	The name of the list.
string	$mode	Whether your list is public or private. Values can be public or private. If no mode is specified the list will be public.
string	$description	The description to give the list.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Références $data, $description, $mode, $name, et $path.

◆ delete()

delete	(	$list,
		$owner = `null`
	)

Method to delete a specified list.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name of the owner.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ deleteMembers()

deleteMembers	(	$list,
		$userId = `null`,
		$screenName = `null`,
		$owner = `null`
	)

Method to remove multiple members from a list, by specifying a comma-separated list of member ids or screen names.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
string	$userId	A comma separated list of user IDs, up to 100 are allowed in a single request.
string	$screenName	A comma separated list of screen names, up to 100 are allowed in a single request.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name of the owner.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

Références $data, $list, $path, $userId, elseif, et null.

◆ getListById()

getListById	(	$list,
		$owner = `null`
	)

Method to get the specified list.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ getLists()

getLists	(	$user,
		$reverse = `null`
	)

Method to get all lists the authenticating or specified user subscribes to, including their own.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the screen name.
boolean	$reverse	Set this to true if you would like owned lists to be returned first. See description above for information on how this parameter works.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ getMembers()

getMembers	(	$list,
		$owner = `null`,
		$entities = `null`,
		$skipStatus = `null`
	)

Method to get the members of the specified list.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name.
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 discreet structure, including: user_mentions, urls, and hashtags.
boolean	$skipStatus	When 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, $list, $path, et elseif.

◆ getStatuses()

getStatuses	(	$list,
		$owner = `null`,
		$sinceId = `0`,
		$maxId = `0`,
		$count = `0`,
		$entities = `null`,
		$includeRts = `null`
	)

Method to get tweet timeline for members of the specified list

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name.
integer	$sinceId	Returns results with an ID greater than (that is, more recent than) the specified ID.
integer	$maxId	Returns results with an ID less than (that is, older than) or equal to the specified ID.
integer	$count	Specifies the number of results to retrieve per "page."
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 discreet structure, including: user_mentions, urls, and hashtags.
boolean	$includeRts	When set to either true, t or 1, the list timeline will contain native retweets (if they exist) in addition to the standard stream of tweets.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

Références $count, $data, $list, $path, et elseif.

◆ getSubscribers()

getSubscribers	(	$list,
		$owner = `null`,
		$cursor = `null`,
		$entities = `null`,
		$skipStatus = `null`
	)

Method to get the subscribers of the specified list.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name.
integer	$cursor	Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging.
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 discreet structure, including: user_mentions, urls, and hashtags.
boolean	$skipStatus	When 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, $list, $path, et elseif.

◆ getSubscriptions()

getSubscriptions	(	$user,
		$count = `0`,
		$cursor = `null`
	)

Method to get a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user's own lists.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the screen name.
integer	$count	The amount of results to return per page. Defaults to 20. Maximum of 1,000 when using cursors.
integer	$cursor	Breaks the results into pages. Provide a value of -1 to begin paging.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ isMember()

isMember	(	$list,
		$user,
		$owner = `null`,
		$entities = `null`,
		$skipStatus = `null`
	)

Method to check if the specified user is a member of the specified list.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$user	Either an integer containing the user ID or a string containing the screen name of the user to remove.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name of the owner.
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 discreet structure, including: user_mentions, urls, and hashtags.
boolean	$skipStatus	When 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, $list, $path, $user, et elseif.

◆ isSubscriber()

isSubscriber	(	$list,
		$user,
		$owner = `null`,
		$entities = `null`,
		$skipStatus = `null`
	)

Method to check if the specified user is a subscriber of the specified list.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$user	Either an integer containing the user ID or a string containing the screen name of the user to remove.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name of the owner.
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 discreet structure, including: user_mentions, urls, and hashtags.
boolean	$skipStatus	When 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, $list, $path, $user, et elseif.

◆ subscribe()

subscribe	(	$list,
		$owner = `null`
	)

Method to subscribe the authenticated user to the specified list.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name of the owner.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ unsubscribe()

unsubscribe	(	$list,
		$owner = `null`
	)

Method to unsubscribe the authenticated user from the specified list.

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name of the owner.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ update()

update	(	$list,
		$owner = `null`,
		$name = `null`,
		$mode = `null`,
		$description = `null`
	)

Method to update the specified list

Paramètres

mixed	$list	Either an integer containing the list ID or a string containing the list slug.
mixed	$owner	Either an integer containing the user ID or a string containing the screen name of the owner.
string	$name	The name of the list.
string	$mode	Whether your list is public or private. Values can be public or private. If no mode is specified the list will be public.
string	$description	The description to give the list.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

Références $data, $description, $list, $mode, $name, $path, et elseif.

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

lists.php

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

Documentation des fonctions membres

◆ addMembers()

◆ create()

◆ delete()

◆ deleteMembers()

◆ getListById()

◆ getLists()

◆ getMembers()

◆ getStatuses()

◆ getSubscribers()

◆ getSubscriptions()

◆ isMember()

◆ isSubscriber()

◆ subscribe()

◆ unsubscribe()

◆ update()