1Net::Twitter::Role::APIU:s:eLrisCtosn(t3r)ibuted Perl DoNceutm:e:nTtwaittitoenr::Role::API::Lists(3)
2
3
4
6 Net::Twitter::Role::API::Lists - Twitter Lists API support for
7 Net::Twitter
8
10 version 4.01043
11
13 use Net::Twitter;
14
15 my $nt = Net::Twitter->new(traits => ['API::Lists'], ...);
16
17 $list = $nt->create_list($owner, { name => $name, description => $desc });
18 $list = $nt->update_list($owner, $list_id, { description => $desc });
19
20 $lists = $nt->get_lists($owner);
21 $lists = $nt->list_lists($owner);
22
23 $list = $nt->get_list($owner, $list_id);
24 $list = $nt->delete_list($owner, $list_id);
25
26 $statuses = $nt->list_statuses($owner, $list_id);
27
28 $lists = $nt->list_memberships($owner);
29 $lists = $nt->list_subscriptions($owner);
30
31 $users = $nt->list_members($owner, $list_id);
32
33 $user_or_undef = $nt->list_members($owner, $list_id, { id => $user_id });
34
35 $user = $nt->add_list_member($owner, $list_id, $user_id);
36 $users = $nt->add_list_members($owner, $list_id, { screen_name => \@screen_names });
37
38 $user = $nt->delete_list_member($owner, $list_id, $user_id);
39 $user = $nt->remove_list_member($owner, $list_id, $user_id);
40
41 $user_or_undef = $nt->is_list_member($owner, $list_id, $user_id);
42
43 $users = $nt->list_subscribers($owner, $list_id);
44
45 $list = $nt->subscribe_list($owner, $list_id);
46 $list = $nt->unsubscribe_list($owner, $list_id);
47
48 $user_or_undef = $nt->is_subscribed_list($owner, $list_id, $user_id);
49 $user_or_undef = $nt->is_list_subscriber($owner, $list_id, $user_id);
50
51 #############################
52 # With the cursor parameter #
53 #############################
54
55 $r = $nt->get_list($user, $list_id, { cursor => $cursor });
56 $lists = $r->{lists};
57
58 $r = $nt->list_memberships($user, { cursor => $cursor });
59 $lists = $r->{lists};
60
61 $r = $nt->list_subscriptions($user, { cursor => $cursor });
62 $lists = $r->{lists};
63
64 $r = $nt->list_members($owner, $list_id, { cursor => $cursor });
65 $users = $r->{users};
66
67 $r = $nt->list_subscribers($owner, $list_id, { cursor => $cursor });
68 $users = $r->{users};
69
71 This module implements methods for the original Twitter Lists API.
72 Twitter has deprecated these API methods and reimplemented them with a
73 saner semantics. The new methods are implemented in the API::REST
74 trait, Net::Twitter::Role::API::REST. This module provides backwards
75 compatibility for code written to use the original Lists API. To use
76 the new API methods, simply remove this trait from your code and change
77 the arguments to its methods to match the new semantics.
78
79 This module may be dropped from Net::Twitter in a future release. It
80 will remain as long as Twitter still provides the underlying API end-
81 points.
82
84 This module adds support to Net::Twitter for the Twitter Lists API.
85
87 Net::Twitter::Role::API::Lists provides a trait for the Twitter Lists
88 API methods. See Net::Twitter for full documentation.
89
91 Net::Twitter
92
94 Marc Mims <marc@questright.com>
95
97 Copyright (c) 2009-2016 Marc Mims
98
100 This library is free software. You may redistribute and modify it under
101 the same terms as Perl itself.
102
103
104
105perl v5.32.1 2021-01-27 Net::Twitter::Role::API::Lists(3)