Net::FreshBooks::API::Iterator - FreshBooks Iterator objects


Net-FreshBooks-API documentation  | view source Contained in the Net-FreshBooks-API distribution.

Index


NAME

Top

Net::FreshBooks::API::Iterator - FreshBooks Iterator objects

VERSION

Top

version 0.21

new

    my $iterator = $class->new(
        {   parent_object => $parent_object,
            args         => {...},
        }
    );

Create a new iterator object. As part of creating the iterator a request is sent to FreshBooks.

next

    my $next_result = $iterator->next(  );

Returns the next item in the iterator.

total

Returns the total number of results available, regardless of how many items are on the current page.

pages

Returns the total number of result pages

current_index

The item we are currently on

AUTHORS

Top

COPYRIGHT AND LICENSE

Top


Net-FreshBooks-API documentation  | view source Contained in the Net-FreshBooks-API distribution.