1#######################################################################
2# ex: set ts=8 sw=4 et
3#########################################################################
4package WWW::Facebook::API::Users;
5
6use warnings;
7use strict;
8use Carp;
9
10sub get_info { return shift->base->call( 'users.getInfo', @_ ); }
11
12sub get_logged_in_user {
13    return shift->base->call( 'users.getLoggedInUser', @_ );
14}
15
16sub has_app_permission {
17    return shift->base->call( 'users.hasAppPermission', @_ );
18}
19
20sub is_app_user {
21    return shift->base->call( 'users.isAppUser', @_ );
22}
23
24sub set_status {
25    return shift->base->call( 'users.setStatus', @_ );
26}
27
28sub is_verified {
29    return shift->base->call( 'users.isVerified', @_ );
30}
31
321;    # Magic true value required at end of module
33__END__
34
35=head1 NAME
36
37WWW::Facebook::API::Users - Facebook Users
38
39=head1 SYNOPSIS
40
41    use WWW::Facebook::API;
42
43=head1 DESCRIPTION
44
45Methods for accessing users with L<WWW::Facebook::API>
46
47=head1 SUBROUTINES/METHODS
48
49=over
50
51=item base
52
53Returns the L<WWW::Facebook::API> base object.
54
55=item new
56
57Constructor.
58
59=item get_info( uids => $uids, fields => $fields )
60
61The users.getInfo method of the Facebook API:
62
63    $response = $client->users->get_info(
64        uids => [ 2343, 3435 ],
65        fields => 'about_me'
66    );
67    $response = $client->users->get_info(
68        uids => 2343,
69        fields => [ qw/about_me quotes/ ]
70    );
71
72=item get_logged_in_user
73
74The users.getLoggedInUser method of the Facebook API:
75
76    $uid = $client->users->get_logged_in_user;
77
78=item has_app_permission
79
80The users.hasAppPermission method of the Facebook API:
81
82    $response = $client->users->has_app_permission(
83        ext_perm => 'status_update|photo_upload'
84    );
85
86=item is_app_user
87
88The users.isAppUser method of the Facebook API:
89
90    $app_added = $client->users->is_app_user;
91
92
93=item set_status
94
95The users.setStatus method of the Facebook API:
96
97    $response = $client->users->set_status(
98        status => 'status message',
99        clear => 1|0,
100    );
101
102=item is_verified
103
104The users.isVerified method of the Facebook API:
105
106    $verified = $client->users->is_verified;
107
108
109=back
110
111=head1 DIAGNOSTICS
112
113None.
114
115=head1 CONFIGURATION AND ENVIRONMENT
116
117WWW::Facebook::API::Users requires no configuration files or environment
118variables.
119
120=head1 DEPENDENCIES
121
122See L<WWW::Facebook::API>
123
124=head1 INCOMPATIBILITIES
125
126None reported.
127
128=head1 BUGS AND LIMITATIONS
129
130No bugs have been reported.
131
132Please report any bugs or feature requests to
133C<bug-www-facebook-api@rt.cpan.org>, or through the web interface at
134L<http://rt.cpan.org>.
135
136=head1 AUTHOR
137
138David Romano  C<< <unobe@cpan.org> >>
139
140=head1 LICENSE AND COPYRIGHT
141
142Copyright (c) 2007-2010, David Romano C<< <unobe@cpan.org> >>. All rights reserved.
143
144This module is free software; you can redistribute it and/or
145modify it under the same terms as Perl itself. See L<perlartistic>.
146
147=head1 DISCLAIMER OF WARRANTY
148
149BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
150FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
151OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
152PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
153EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
154WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
155ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
156YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
157NECESSARY SERVICING, REPAIR, OR CORRECTION.
158
159IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
160WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
161REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
162LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
163OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
164THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
165RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
166FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
167SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
168SUCH DAMAGES.
169