Olaf Alders > Net-FreshBooks-API-0.24 > Net::FreshBooks::API::Role::Iterator

Download:
Net-FreshBooks-API-0.24.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.24   Source  

NAME ^

Net::FreshBooks::API::Role::Iterator - Read-only roles

VERSION ^

version 0.24

SYNOPSIS ^

These roles are used for iterating over returned results as well as handling pagination. See the various modules which implement these methods for specific examples of how these methods are used.

get( $args )

get_all( $args )

Iterates over all pages of results provided by FreshBooks. Calling get_all means you don't need to worry about explicitly handling pagination in requests. Returns an ARRAYREF of the requested objects.

list( $args )

Returns an iterator object.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Edmund von der Burg & Olaf Alders.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: