.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Twitter::Role::API::Lists 3pm"
.TH Net::Twitter::Role::API::Lists 3pm "2022-06-16" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Twitter::Role::API::Lists \- Twitter Lists API support for Net::Twitter
.SH "VERSION"
.IX Header "VERSION"
version 4.01043
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::Twitter;
\&
\&  my $nt = Net::Twitter\->new(traits => [\*(AqAPI::Lists\*(Aq], ...);
\&
\&  $list = $nt\->create_list($owner, { name => $name, description => $desc });
\&  $list = $nt\->update_list($owner, $list_id, { description => $desc });
\&
\&  $lists = $nt\->get_lists($owner);
\&  $lists = $nt\->list_lists($owner);
\&
\&  $list = $nt\->get_list($owner, $list_id);
\&  $list = $nt\->delete_list($owner, $list_id);
\&
\&  $statuses = $nt\->list_statuses($owner, $list_id);
\&
\&  $lists = $nt\->list_memberships($owner);
\&  $lists = $nt\->list_subscriptions($owner);
\&
\&  $users = $nt\->list_members($owner, $list_id);
\&
\&  $user_or_undef = $nt\->list_members($owner, $list_id, { id => $user_id });
\&
\&  $user = $nt\->add_list_member($owner, $list_id, $user_id);
\&  $users = $nt\->add_list_members($owner, $list_id, { screen_name => \e@screen_names });
\&
\&  $user = $nt\->delete_list_member($owner, $list_id, $user_id);
\&  $user = $nt\->remove_list_member($owner, $list_id, $user_id);
\&
\&  $user_or_undef = $nt\->is_list_member($owner, $list_id, $user_id);
\&
\&  $users = $nt\->list_subscribers($owner, $list_id);
\&
\&  $list = $nt\->subscribe_list($owner, $list_id);
\&  $list = $nt\->unsubscribe_list($owner, $list_id);
\&
\&  $user_or_undef = $nt\->is_subscribed_list($owner, $list_id, $user_id);
\&  $user_or_undef = $nt\->is_list_subscriber($owner, $list_id, $user_id);
\&
\&  #############################
\&  # With the cursor parameter #
\&  #############################
\&
\&  $r = $nt\->get_list($user, $list_id, { cursor => $cursor });
\&  $lists = $r\->{lists};
\&
\&  $r = $nt\->list_memberships($user, { cursor => $cursor });
\&  $lists = $r\->{lists};
\&
\&  $r = $nt\->list_subscriptions($user, { cursor => $cursor });
\&  $lists = $r\->{lists};
\&
\&  $r = $nt\->list_members($owner, $list_id, { cursor => $cursor });
\&  $users = $r\->{users};
\&
\&  $r = $nt\->list_subscribers($owner, $list_id, { cursor => $cursor });
\&  $users = $r\->{users};
.Ve
.SH "DEPRECATION NOTICE"
.IX Header "DEPRECATION NOTICE"
This module implements methods for the original Twitter Lists \s-1API.\s0  Twitter has
deprecated these \s-1API\s0 methods and reimplemented them with a saner semantics.
The new methods are implemented in the \s-1API::REST\s0 trait,
Net::Twitter::Role::API::REST.  This module provides backwards
compatibility for code written to use the original Lists \s-1API.\s0  To use the
new \s-1API\s0 methods, simply remove this trait from your code and change the
arguments to its methods to match the new semantics.
.PP
This module may be dropped from Net::Twitter in a future release.  It will
remain as long as Twitter still provides the underlying \s-1API\s0 end-points.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module adds support to Net::Twitter for the Twitter Lists \s-1API.\s0
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBNet::Twitter::Role::API::Lists\fR provides a trait for the Twitter Lists \s-1API\s0 methods.
See Net::Twitter for full documentation.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::Twitter
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Mims <marc@questright.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2009\-2016 Marc Mims
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software. You may redistribute and modify it under the
same terms as Perl itself.