.\" 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 "WWW::Facebook::API::Canvas 3pm"
.TH WWW::Facebook::API::Canvas 3pm "2022-06-28" "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"
WWW::Facebook::API::Canvas \- Facebook Canvas
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use WWW::Facebook::API;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Methods for using the canvas with WWW::Facebook::API
.PP
The \f(CW$q\fR parameter should implement the param and cookie methods (for example a \s-1CGI\s0 or Apache::Request object).
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.IP "base" 4
.IX Item "base"
Returns the WWW::Facebook::API base object.
.IP "new" 4
.IX Item "new"
Constructor.
.ie n .IP "get_user( $q )" 4
.el .IP "get_user( \f(CW$q\fR )" 4
.IX Item "get_user( $q )"
Return the \s-1UID\s0 of the canvas user or "" if it does not exist (See
\&\s-1DESCRIPTION\s0):
.Sp
.Vb 1
\&    $response = $client\->canvas\->get_user( $q )
.Ve
.Sp
If \f(CW$q\fR is not passed in, the value returned by \f(CW\*(C`$client\->base\->query()\*(C'\fR is
used.
.ie n .IP "get_fb_params( $q )" 4
.el .IP "get_fb_params( \f(CW$q\fR )" 4
.IX Item "get_fb_params( $q )"
Return a hash reference to the signed parameters sent via Facebook (See
\&\s-1DESCRIPTION\s0):
.Sp
.Vb 1
\&    $response = $client\->canvas\->get_fb_params( $q )
.Ve
.Sp
If \f(CW$q\fR is not passed in, the value returned by \f(CW\*(C`$client\->base\->query()\*(C'\fR is
used.
.ie n .IP "get_non_fb_params( $q )" 4
.el .IP "get_non_fb_params( \f(CW$q\fR )" 4
.IX Item "get_non_fb_params( $q )"
Return a hash reference to the parameters that are not part of the signed
facebook parameters. This is useful if your app send a \s-1POST\s0 request to
Facebook and you want to use the data you POSTed:
.Sp
.Vb 1
\&    $non_fb_params = $client\->canvas\->get_non_fb_params( $q )
.Ve
.Sp
If \f(CW$q\fR is not passed in, the value returned by \f(CW\*(C`$client\->base\->query()\*(C'\fR is
used.
.ie n .IP "in_fb_canvas( $q )" 4
.el .IP "in_fb_canvas( \f(CW$q\fR )" 4
.IX Item "in_fb_canvas( $q )"
Return true if inside a canvas (See \s-1DESCRIPTION\s0):
.Sp
.Vb 1
\&    $response = $client\->canvas\->in_fb_canvas( $q )
.Ve
.Sp
If \f(CW$q\fR is not passed in, the value returned by \f(CW\*(C`$self\->base\->query()\*(C'\fR is
used.
.ie n .IP "in_frame( $q )" 4
.el .IP "in_frame( \f(CW$q\fR )" 4
.IX Item "in_frame( $q )"
Return true if inside an iframe or canvas (See \s-1DESCRIPTION\s0):
.Sp
.Vb 1
\&    $response = $client\->canvas\->in_frame( $q )
.Ve
.Sp
If \f(CW$q\fR is not passed in, the value returned by \f(CW\*(C`$self\->base\->query()\*(C'\fR is
used.
.ie n .IP "validate_sig( $q )" 4
.el .IP "validate_sig( \f(CW$q\fR )" 4
.IX Item "validate_sig( $q )"
Return a hash reference containing the fb_sig_* params (with \f(CW\*(C`fb_sig_\*(C'\fR
stripped) if the signature of the \f(CW$q\fR object is valid for this application (See
\&\s-1DESCRIPTION\s0):
.Sp
.Vb 2
\&    $fb_params = $client\->canvas\->validate_sig( $q )
\&    # $fb_params doesn\*(Aqt contain a sig key
.Ve
.Sp
If \f(CW$q\fR is not passed in, the value returned by \f(CW\*(C`$self\->base\->query()\*(C'\fR is
used.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.ie n .IP "Multiple values for %s. Are you using \s-1POST\s0 for forms?" 4
.el .IP "Multiple values for \f(CW%s\fR. Are you using \s-1POST\s0 for forms?" 4
.IX Item "Multiple values for %s. Are you using POST for forms?"
Your forms are most likely using \s-1GET\s0 rather than \s-1POST\s0 to the Facebook URLs.
Change your forms to using \s-1POST\s0 and the problem should be resolved. (See
RT#31620 and RT#31944 for more information).
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
WWW::Facebook::API::Canvas requires no configuration files or environment
variables.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
See WWW::Facebook::API
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
No bugs have been reported.
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-www\-facebook\-api@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.
.SH "AUTHORS"
.IX Header "AUTHORS"
David Leadbeater  \f(CW\*(C`http://dgl.cx\*(C'\fR
.PP
David Romano  \f(CW\*(C`<unobe@cpan.org>\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2007, David Leadbeater \f(CW\*(C`http://dgl.cx\*(C'\fR.
Certain parts copyright (c) 2007\-2010, David Romano \f(CW\*(C`<unobe@cpan.org>\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE 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 \*(L"AS IS\*(R" 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.\s0
.PP
\&\s-1IN 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\s0 (\s-1INCLUDING 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\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0