canvas::API method paginated_result_list (protected)

 <instance of canvas::API> paginated_result_list \
    [ -max_entries max_entries ] r expected_status_code

Defined in packages/xooauth/tcl/canvas-procs.tcl

By default, Canvas returns for a query just the first 10 results ("pagination"). To obtain more results, it is necessary to issue multiple requests. If "max_entries" is specified, the interface tries to get the requested number of entries. If there are less entries available, just these are returned.

Switches:

-max_entries (optional)

Parameters:

r (required)

expected_status_code (required)

Testcases:

No testcase defined.