rest_framework.pagination.LimitOffsetPagination

class documentation

class LimitOffsetPagination(BasePagination): (source)

View In Hierarchy

A limit/offset based style. For example: http://api.example.org/accounts/?limit=100 http://api.example.org/accounts/?offset=400&limit=100

Method get_count Determine an object count, supporting either querysets or regular lists.
Method get_html_context Undocumented
Method get_limit Undocumented
Method get_next_link Undocumented
Method get_offset Undocumented
Method get_paginated_response Undocumented
Method get_paginated_response_schema Undocumented
Method get_previous_link Undocumented
Method get_schema_fields Undocumented
Method get_schema_operation_parameters Undocumented
Method paginate_queryset Undocumented
Method to_html Undocumented
Class Variable limit_query_description Undocumented
Class Variable limit_query_param Undocumented
Class Variable max_limit Undocumented
Class Variable offset_query_description Undocumented
Class Variable offset_query_param Undocumented
Class Variable template Undocumented
Instance Variable count Undocumented
Instance Variable display_page_controls Undocumented
Instance Variable limit Undocumented
Instance Variable offset Undocumented
Instance Variable request Undocumented

Inherited from BasePagination:

Method get_results Undocumented
def get_count(self, queryset): (source)

Determine an object count, supporting either querysets or regular lists.

def get_html_context(self): (source)

Undocumented

def get_limit(self, request): (source)

Undocumented

def get_next_link(self): (source)

Undocumented

def get_offset(self, request): (source)

Undocumented

def get_paginated_response(self, data): (source)
overrides rest_framework.pagination.BasePagination.get_paginated_response

Undocumented

def get_paginated_response_schema(self, schema): (source)
overrides rest_framework.pagination.BasePagination.get_paginated_response_schema

Undocumented

def get_previous_link(self): (source)

Undocumented

def get_schema_fields(self, view): (source)
overrides rest_framework.pagination.BasePagination.get_schema_fields

Undocumented

def get_schema_operation_parameters(self, view): (source)
overrides rest_framework.pagination.BasePagination.get_schema_operation_parameters

Undocumented

def paginate_queryset(self, queryset, request, view=None): (source)
overrides rest_framework.pagination.BasePagination.paginate_queryset

Undocumented

def to_html(self): (source)
overrides rest_framework.pagination.BasePagination.to_html

Undocumented

limit_query_description = (source)

Undocumented

limit_query_param: str = (source)

Undocumented

max_limit = (source)

Undocumented

offset_query_description = (source)

Undocumented

offset_query_param: str = (source)

Undocumented

template: str = (source)

Undocumented

count = (source)

Undocumented

display_page_controls: bool = (source)
overrides rest_framework.pagination.BasePagination.display_page_controls

Undocumented

limit = (source)

Undocumented

offset = (source)

Undocumented

request = (source)

Undocumented