—#######################################################################
# $Date: 2007-06-07 22:28:00 -0700 (Thu, 07 Jun 2007) $
# $Revision: 101 $
# $Author: david.romano $
# ex: set ts=8 sw=4 et
#########################################################################
package
WWW::Facebook::API::Users;
use
warnings;
use
strict;
use
Carp;
sub
base {
return
shift
->{
'base'
}; }
sub
new {
my
(
$self
,
%args
) =
@_
;
my
$class
=
ref
$self
||
$self
;
$self
=
bless
\
%args
,
$class
;
delete
$self
->{
$_
}
for
grep
{ !/base/xms }
keys
%{
$self
};
for
(
keys
%{
$self
} ) {
$self
->
$_
}
return
$self
;
}
sub
get_info {
return
shift
->base->call(
'users.getInfo'
,
@_
); }
sub
get_logged_in_user {
return
shift
->base->call(
'users.getLoggedInUser'
,
@_
);
}
sub
is_app_added {
return
shift
->base->call(
'users.isAppAdded'
,
@_
); }
1;
# Magic true value required at end of module
__END__
=head1 NAME
WWW::Facebook::API::Users - Facebook Users
=head1 VERSION
This document describes WWW::Facebook::API::Users version 0.3.3
=head1 SYNOPSIS
use WWW::Facebook::API;
=head1 DESCRIPTION
Methods for accessing users with L<WWW::Facebook::API>
=head1 SUBROUTINES/METHODS
=over
=item new()
Returns a new instance of this class.
=item base()
The L<WWW::Facebook::API> object to use to make calls to the REST server.
=item get_info( uids => $uids, fields => $fields )
The users.getInfo method of the Facebook API:
$response = $client->users->get_info(
uids => [ 2343, 3435 ],
fields => 'about_me'
);
$response = $client->users->get_info(
uids => 2343,
fields => [ qw/about_me quotes/ ]
);
=item get_logged_in_user
The users.getLoggedInUser method of the Facebook API:
$uid = $client->users->get_logged_in_user;
=item is_app_added
The users.getIsAppAdded method of the Facebook API (currently not documented,
but is present in the PHP client):
$user_has_app = $client->users->is_app_added;
=back
=head1 DIAGNOSTICS
None.
=head1 CONFIGURATION AND ENVIRONMENT
WWW::Facebook::API::Users requires no configuration files or environment
variables.
=head1 DEPENDENCIES
See L<WWW::Facebook::API>
=head1 INCOMPATIBILITIES
None reported.
=head1 BUGS AND LIMITATIONS
No bugs have been reported.
Please report any bugs or feature requests to
C<bug-www-facebook-api@rt.cpan.org>, or through the web interface at
=head1 AUTHOR
David Romano C<< <unobe@cpan.org> >>
=head1 LICENSE AND COPYRIGHT
Copyright (c) 2007, David Romano C<< <unobe@cpan.org> >>. All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=head1 DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.