Référence de la classe JTwitterLists

Graphe d'héritage de JTwitterLists:

Graphe de collaboration de JTwitterLists:

Liste de tous les membres

Fonctions membres publiques
	getLists ($user, $reverse=null)
	getStatuses ($list, $owner=null, $since_id=0, $max_id=0, $count=0, $entities=null, $include_rts=null)
	getSubscribers ($list, $owner=null, $cursor=null, $entities=null, $skip_status=null)
	deleteMembers ($list, $user_id=null, $screen_name=null, $owner=null)
	subscribe ($list, $owner=null)
	isMember ($list, $user, $owner=null, $entities=null, $skip_status=null)
	isSubscriber ($list, $user, $owner=null, $entities=null, $skip_status=null)
	unsubscribe ($list, $owner=null)
	addMembers ($list, $user_id=null, $screen_name=null, $owner=null)
	getMembers ($list, $owner=null, $entities=null, $skip_status=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 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 lists.php.

---

Documentation des fonctions membres

JTwitterLists::addMembers	(		$list,
			$user_id = null,
			$screen_name = 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	$user_id	A comma separated list of user IDs, up to 100 are allowed in a single request.
string	$screen_name	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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 584 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'members/create_all');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                if ($user_id)
                {
                        $data['user_id'] = $user_id;
                }
                if ($screen_name)
                {
                        $data['screen_name'] = $screen_name;
                }
                if ($user_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 = '/lists/members/create_all.json';

                // Send the request.
                return $this->sendRequest($path, 'POST', $data);
        }

JTwitterLists::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:

12.3

Définition à la ligne 900 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'create');

                // Check if name is specified.
                if ($name)
                {
                        $data['name'] = $name;
                }

                // Check if mode is specified.
                if ($mode)
                {
                        $data['mode'] = $mode;
                }

                // Check if description is specified.
                if ($description)
                {
                        $data['description'] = $description;
                }

                // Set the API path
                $path = '/lists/create.json';

                // Send the request.
                return $this->sendRequest($path, 'POST', $data);
        }

JTwitterLists::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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 941 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'destroy');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        else
                        {
                                // We don't have a valid entry
                                throw new RuntimeException('The specified username for owner is not in the correct format; must use integer or string');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                // Set the API path
                $path = '/lists/destroy.json';

                // Send the request.
                return $this->sendRequest($path, 'POST', $data);
        }

JTwitterLists::deleteMembers	(		$list,
			$user_id = null,
			$screen_name = 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	$user_id	A comma separated list of user IDs, up to 100 are allowed in a single request.
string	$screen_name	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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 246 du fichier lists.php.

        {
                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        else
                        {
                                // We don't have a valid entry
                                throw new RuntimeException('The specified username for owner is not in the correct format; must use integer or string');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                if ($user_id)
                {
                        $data['user_id'] = $user_id;
                }
                if ($screen_name)
                {
                        $data['screen_name'] = $screen_name;
                }
                if ($user_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 = '/lists/members/destroy_all.json';

                // Send the request.
                return $this->sendRequest($path, 'POST', $data);
        }

JTwitterLists::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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 720 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'show');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                // Set the API path
                $path = '/lists/show.json';

                // Send the request.
                return $this->sendRequest($path, 'GET', $data);
        }

JTwitterLists::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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 33 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'list');

                // 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 reverse is specified.
                if (!is_null($reverse))
                {
                        $data['reverse'] = $reverse;
                }

                // Set the API path
                $path = '/lists/list.json';

                // Send the request.
                return $this->sendRequest($path, 'GET', $data);
        }

JTwitterLists::getMembers	(		$list,
			$owner = null,
			$entities = null,
			$skip_status = 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	$skip_status	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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 654 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'members');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                // Set the API path
                $path = '/lists/members.json';

                // Check if entities is specified
                if (!is_null($entities))
                {
                        $data['include_entities'] = $entities;
                }

                // Check if skip_status is specified
                if (!is_null($skip_status))
                {
                        $data['skip_status'] = $skip_status;
                }

                // Send the request.
                return $this->sendRequest($path, 'GET', $data);

        }

JTwitterLists::getStatuses	(		$list,
			$owner = null,
			$since_id = 0,
			$max_id = 0,
			$count = 0,
			$entities = null,
			$include_rts = 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	$since_id	Returns results with an ID greater than (that is, more recent than) the specified ID.
integer	$max_id	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	$include_rts	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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 84 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'statuses');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                // Set the API path
                $path = '/lists/statuses.json';

                // Check if since_id is specified
                if ($since_id > 0)
                {
                        $data['since_id'] = $since_id;
                }

                // Check if max_id is specified
                if ($max_id > 0)
                {
                        $data['max_id'] = $max_id;
                }

                // Check if count is specified
                if ($count > 0)
                {
                        $data['count'] = $count;
                }

                // Check if entities is specified
                if (!is_null($entities))
                {
                        $data['include_entities'] = $entities;
                }

                // Check if include_rts is specified
                if (!is_null($include_rts))
                {
                        $data['include_rts'] = $include_rts;
                }

                // Send the request.
                return $this->sendRequest($path, 'GET', $data);

        }

JTwitterLists::getSubscribers	(		$list,
			$owner = null,
			$cursor = null,
			$entities = null,
			$skip_status = 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	$skip_status	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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 172 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'subscribers');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                // Set the API path
                $path = '/lists/subscribers.json';

                // Check if cursor is specified
                if (!is_null($cursor))
                {
                        $data['cursor'] = $cursor;
                }

                // Check if entities is specified
                if (!is_null($entities))
                {
                        $data['include_entities'] = $entities;
                }

                // Check if skip_status is specified
                if (!is_null($skip_status))
                {
                        $data['skip_status'] = $skip_status;
                }

                // Send the request.
                return $this->sendRequest($path, 'GET', $data);

        }

JTwitterLists::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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 774 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'subscriptions');

                // 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 count is specified.
                if ($count > 0)
                {
                        $data['count'] = $count;
                }

                // Check if cursor is specified.
                if (!is_null($cursor))
                {
                        $data['cursor'] = $cursor;
                }

                // Set the API path
                $path = '/lists/subscriptions.json';

                // Send the request.
                return $this->sendRequest($path, 'GET', $data);
        }

JTwitterLists::isMember	(		$list,
			$user,
			$owner = null,
			$entities = null,
			$skip_status = 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	$skip_status	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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 367 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'members/show');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                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 = '/lists/members/show.json';

                // Check if entities is specified
                if (!is_null($entities))
                {
                        $data['include_entities'] = $entities;
                }

                // Check if skip_status is specified
                if (!is_null($skip_status))
                {
                        $data['skip_status'] = $skip_status;
                }

                // Send the request.
                return $this->sendRequest($path, 'GET', $data);
        }

JTwitterLists::isSubscriber	(		$list,
			$user,
			$owner = null,
			$entities = null,
			$skip_status = 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	$skip_status	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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 450 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'subscribers/show');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                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 = '/lists/subscribers/show.json';

                // Check if entities is specified
                if (!is_null($entities))
                {
                        $data['include_entities'] = $entities;
                }

                // Check if skip_status is specified
                if (!is_null($skip_status))
                {
                        $data['skip_status'] = $skip_status;
                }

                // Send the request.
                return $this->sendRequest($path, 'GET', $data);
        }

JTwitterLists::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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 310 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'subscribers/create');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        else
                        {
                                // We don't have a valid entry
                                throw new RuntimeException('The specified username for owner is not in the correct format; must use integer or string');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                // Set the API path
                $path = '/lists/subscribers/create.json';

                // Send the request.
                return $this->sendRequest($path, 'POST', $data);
        }

JTwitterLists::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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 529 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'subscribers/destroy');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                // Set the API path
                $path = '/lists/subscribers/destroy.json';

                // Send the request.
                return $this->sendRequest($path, 'POST', $data);
        }

JTwitterLists::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:

12.3

Exceptions:

RuntimeException

Définition à la ligne 828 du fichier lists.php.

        {
                // Check the rate limit for remaining hits
                $this->checkRateLimit('lists', 'update');

                // Determine which type of data was passed for $list
                if (is_numeric($list))
                {
                        $data['list_id'] = $list;
                }
                elseif (is_string($list))
                {
                        $data['slug'] = $list;

                        // In this case the owner is required.
                        if (is_numeric($owner))
                        {
                                $data['owner_id'] = $owner;
                        }
                        elseif (is_string($owner))
                        {
                                $data['owner_screen_name'] = $owner;
                        }
                        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');
                        }
                }
                else
                {
                        // We don't have a valid entry
                        throw new RuntimeException('The specified list is not in the correct format; must use integer or string');
                }

                // Check if name is specified.
                if ($name)
                {
                        $data['name'] = $name;
                }

                // Check if mode is specified.
                if ($mode)
                {
                        $data['mode'] = $mode;
                }

                // Check if description is specified.
                if ($description)
                {
                        $data['description'] = $description;
                }

                // Set the API path
                $path = '/lists/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 :

• jplatform-13.1/joomla/twitter/lists.php