.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 "Flickr::API::People 3pm" .TH Flickr::API::People 3pm 2024-03-02 "perl v5.38.2" "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 Flickr::API::People \- Perl interface to the Flickr API's flickr.people.* methods. .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use Flickr::API::People; \& \& my $api = Flickr::API::People\->new({\*(Aqconsumer_key\*(Aq => \*(Aqyour_api_key\*(Aq}); .Ve .PP or .PP .Vb 1 \& my $api = Flickr::API::People\->import_storable_config($config_file); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This object encapsulates the flickr people methods. .PP \&\f(CW\*(C`Flickr::API::People\*(C'\fR is a subclass of Flickr::API, so you can access Flickr's people information easily. .SH SUBROUTINES/METHODS .IX Header "SUBROUTINES/METHODS" .ie n .IP findByEmail() 4 .el .IP \f(CWfindByEmail()\fR 4 .IX Item "findByEmail()" Populates user info with that found for the given email .ie n .IP findByUsername() 4 .el .IP \f(CWfindByUsername()\fR 4 .IX Item "findByUsername()" Populates user info with that found for the given username .ie n .IP perms() 4 .el .IP \f(CWperms()\fR 4 .IX Item "perms()" Returns the permission returned by checking this supplied token .ie n .IP """perms_caller""" 4 .el .IP \f(CWperms_caller\fR 4 .IX Item "perms_caller" Returns the username for which the permission applies .ie n .IP """perms_token""" 4 .el .IP \f(CWperms_token\fR 4 .IX Item "perms_token" Returns the token for which the permission applies .ie n .IP """perms_nsid""" 4 .el .IP \f(CWperms_nsid\fR 4 .IX Item "perms_nsid" Returns the nsid for which the permission applies .ie n .IP nsid() 4 .el .IP \f(CWnsid()\fR 4 .IX Item "nsid()" Returns the nsid of the supplied mail or username .ie n .IP username() 4 .el .IP \f(CWusername()\fR 4 .IX Item "username()" Returns the username of the supplied mail or username .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright (C) 2015\-2016, Louis B. Moore .PP This program is released under the Artistic License 2.0 by The Perl Foundation. .PP Original version was Copyright (C) 2005 Nuno Nunes, \f(CW\*(C`\*(C'\fR This version is much changed and built on the Flickr::API as it appears in 2015. Many thanks to Nuno Nunes for getting this ball rolling. .SH "SEE ALSO" .IX Header "SEE ALSO" Flickr::API. Flickr ,