Yanick Champoux > WWW-Ohloh-API-v0.3.2 > WWW::Ohloh::API::Stack

Download:
WWW-Ohloh-API-v0.3.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: v0.3.2   Source  

NAME ^

WWW::Ohloh::API::Stack - a collection of projects used by a person

SYNOPSIS ^

    use WWW::Ohloh::API;

    my $ohloh = WWW::Ohloh::API->new( api_key => $my_api_key );

    # get the stack of a person
    my $stack = $ohloh->get_account_stack( $account_id );

    # get stacks containing a project
    my @stacks = $ohloh->get_project_stacks( $project_id );

DESCRIPTION ^

W::O::A::Stack represents a collection of projects used by a person.

METHODS ^

API Data Accessors

id

Returns the unique id for the stack.

updated_at

Returns the most recent time at which any projects were added to or removed from this stack as a Time::Piece object.

project_count

Returns the number of projects in the stack.

stack_entries

Returns a list of the entries contained by the stack as WWW::Ohloh::API::StackEntry objects.

account_id

Returns the id of the account owning the stack.

account( $retrieve )

Returns the account associated to the stack as a WWW::Ohloh::API::Account object.

If the account information was not present at the object's creation time, it will be queried from the ohloh server, unless $retrieve is defined and set to false.

Other Methods

as_xml

Returns the stack as an XML string. Note that this is not the same xml document as returned by the Ohloh server.

SEE ALSO ^

VERSION ^

This document describes WWW::Ohloh::API version 0.3.2

BUGS AND LIMITATIONS ^

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

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.

syntax highlighting: