Clayton L. Scott > WWW-Bebo-API > WWW::Bebo::API::Canvas

Download:
WWW-Bebo-API-0.0.03.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.0.3   Source  

NAME ^

WWW::Bebo::API::Canvas - Bebo Canvas

VERSION ^

This document describes WWW::Bebo::API::Canvas version 0.0.03

SYNOPSIS ^

    use WWW::Bebo::API;

DESCRIPTION ^

Methods for using the canvas with WWW::Bebo::API

The $q parameter should implement the param method (for example a CGI or Apache::Request object).

SUBROUTINES/METHODS ^

base

Returns the WWW::Bebo::API base object.

new

Constructor.

get_user( $q )

Return the UID of the canvas user or "" if it does not exist (See DESCRIPTION):

    $response = $client->canvas->get_user( $q )

If $q is not passed in, the value returned by $client->base->query() is used.

get_fb_params( $q )

Return a hash reference to the signed parameters sent via Bebo (See DESCRIPTION):

    $response = $client->canvas->get_fb_params( $q )

If $q is not passed in, the value returned by $client->base->query() is used.

get_non_fb_params( $q )

Return a hash reference to the parameters that are not part of the signed bebo parameters. This is useful if your app send a POST request to Bebo and you want to use the data you POSTed:

    $non_fb_params = $client->canvas->get_non_fb_params( $q )

If $q is not passed in, the value returned by $client->base->query() is used.

in_fb_canvas( $q )

Return true if inside a canvas (See DESCRIPTION):

    $response = $client->canvas->in_fb_canvas( $q )

If $q is not passed in, the value returned by $self->base->query() is used.

in_frame( $q )

Return true if inside an iframe or canvas (See DESCRIPTION):

    $response = $client->canvas->in_frame( $q )

If $q is not passed in, the value returned by $self->base->query() is used.

validate_sig( $q )

Return a hash reference containing the fb_sig_* params (with fb_sig_ stripped) if the signature of the $q object is valid for this application (See DESCRIPTION):

    $fb_params = $client->canvas->validate_sig( $q )
    # $fb_params doesn't contain a sig key

If $q is not passed in, the value returned by $self->base->query() is used.

DIAGNOSTICS ^

None.

CONFIGURATION AND ENVIRONMENT ^

WWW::Bebo::API::Canvas requires no configuration files or environment variables.

DEPENDENCIES ^

See WWW::Bebo::API

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-www-bebo-api@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

David Leadbeater http://dgl.cx David Romano <unobe@cpan.org>

LICENSE AND COPYRIGHT ^

Copyright (c) 2007, David Leadbeater http://dgl.cx. David Romano <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 perlartistic.

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.

syntax highlighting: