PaginatedList

class canvasapi.paginated_list.PaginatedList(content_class: Type[T], requester, request_method, first_url, extra_attribs=None, _root=None, _url_override=None, **kwargs)

Abstracts pagination of Canvas API.

Parameters:

  • content_class (class) – The expected type to return in the list.

  • requester (canvasapi.requester.Requester) – The requester to pass HTTP requests through.

  • request_method (str) – HTTP request method

  • first_url (str) – Canvas endpoint for the initial request

  • extra_attribs (dict) – Extra data to include in the request

  • _root (str) – Specify a nested property from Canvas to use for the resulting list.

  • _url_override – “new_quizzes” or “graphql” for specific Canvas endpoints.

Other URLs may be specified for third-party requests. :type _url_override: str :rtype: canvasapi.paginated_list.PaginatedList of type content_class