The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
WWW-Ohloh-API-1.0_0
River stage zero No dependents
++
/ WWW::Ohloh::API::Kudo

NAME

WWW::Ohloh::API::Kudo - an Ohloh kudo

SYNOPSIS

    use WWW::Ohloh::API;

    my $ohloh    = WWW::Ohloh::API->new( api_key => $my_api_key );
    my $account  = $ohloh->fetch_account( 12933 );
    my @received = $account->received_kudos;

    # or, from $ohloh directly
    my @sent = $ohloh->get_kudos( id => 12933 )->sent;

DESCRIPTION

W::O::A::Kudo contains the information associated with an Ohloh kudo as defined at http://www.ohloh.net/api/reference/kudo. To be properly populated, it must be created via the get_kudos method of a WWW::Ohloh::API object, or via the received_kudos/sent_kudos methods of a WWW::Ohloh::API::Account object.

METHODS

API Data Accessors

created_at

Return the kudo's creation time.

sender_account_id, sender_account_name

Return the id/name of the account sending the kudo.

receiver_account_id, receiver_account_name

Return the id/name associated with the account that received the kudo, or an empty string if the kudo couldn't be linked to an account.

project_id, project_name

Return the project id/name if the kudo was sent to a project contributor instead than an account, or an empty string otherwise.

contributor_id, contributor_name

Return the cotnributor's id/name if the kudo was sent to a project contributor instead than an account, or an empty string otherwise.

Other Methods

as_xml

Return the kudo information as an XML string. Note that this is not the exact xml document as returned by the Ohloh server.

SEE ALSO

VERSION

This document describes WWW::Ohloh::API version 1.0_0

BUGS AND LIMITATIONS

WWW::Ohloh::API is very extremely alpha quality. It'll improve, but till then: Caveat emptor.

The as_xml() method returns a re-encoding of the account data, which can differ of the original xml document sent by the Ohloh server.

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

AUTHOR

Yanick Champoux <yanick@cpan.org>

LICENCE AND COPYRIGHT

Copyright (c) 2008, Yanick Champoux <yanick@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.