The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
WWW-Facebook-API-v0.3.0
River stage one • 5 direct dependents • 6 total dependents
1 ++
/ WWW::Facebook::API::Auth

NAME

WWW::Facebook::API::Auth - Authentication utilities for Client

VERSION

This document describes WWW::Facebook::API::Auth version 0.3.0

SYNOPSIS

    use WWW::Facebook::API;

DESCRIPTION

Methods for accessing auth with WWW::Facebook::API

METHODS

new()

Returns a new instance of this class.

base()

The WWW::Facebook::API object that the current object is attached to. (Used to access settings.)

create_token()

auth.createToken of the Facebook API. Will always return the token string, regardles of the 'parse' setting in WWW::Facebook::API.

get_session( $auth_token )

auth.getSession of the Facebook API. If you have a desktop app, create_token will be called if $auth_token isn't passed in. If you have a web app, the secret in WWW::Facebook::API will be used if $auth_token isn't passed in. Either way, it automatically sets session_uid session_key and session_expires. Nothing is returned.

login( user => $username, pass => $password )

Not part of the official Facebook API. Logs in to Facebook using WWW::Mechanize. The 'user' and 'pass' parameters must be supplied. If you have a desktop app, create_token will automatically be called. Returns the session token.

logout()

Sends a POST to http://www.facebook.com/logout.php, with the parameter "confirm" set to 1 (Cf. http://developers.facebook.com/documentation.php?v=1.0&doc=auth )

INTERNAL FUNCTIONS

_make_secure

Changes the server_uri to https for get_session.

_make_unsecure

Changes the server_uri back to http at the end of get_session.

DIAGNOSTICS

None.

CONFIGURATION AND ENVIRONMENT

WWW::Facebook::API::Auth requires no configuration files or environment variables.

DEPENDENCIES

See WWW::Facebook::API

INCOMPATIBILITIES

None.

BUGS AND LIMITATIONS

No bugs have been reported.

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

AUTHOR

David Romano <unobe@cpan.org>

LICENSE AND COPYRIGHT

Copyright (c) 2007, 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.