Package com.auth0.client.mgmt.filter

Class PageFilter

java.lang.Object
com.auth0.client.mgmt.filter.BaseFilter
com.auth0.client.mgmt.filter.PageFilter
Direct Known Subclasses:
RolesFilter
public class PageFilter extends BaseFilter
Class used to filter the results received when calling an endpoint that supports Pagination.

This class is not thread-safe.

See Also:

  • Constructor Details

    • PageFilter

      public PageFilter()

  • Method Details

    • withPage

      public PageFilter withPage(int pageNumber, int amountPerPage)
      Filter by page
      Parameters:
      pageNumber - the page number to retrieve.
      amountPerPage - the amount of items per page to retrieve.
      Returns:
      this filter instance

    • withTotals

      public PageFilter withTotals(boolean includeTotals)
      Include the query summary
      Parameters:
      includeTotals - whether to include or not the query summary.
      Returns:
      this filter instance

    • withFrom

      public PageFilter withFrom(String from)
      Include the from parameter to specify where to start the page selection. Only applicable for endpoints that support checkpoint pagination.

      Note: If this or the withTake(int) is specified, any offset paging parameters set via withPage(int, int) or withTotals(boolean) will be disregarded by the API.

      Parameters:
      from - the ID from which to start selection. This can be obtained from the next field returned from a checkpoint-paginated result.
      Returns:
      this filter instance.

    • withTake

      public PageFilter withTake(int take)
      Include the take parameter to specify the amount of results to return per page. Only applicable for endpoints that support checkpoint pagination.

      Note: If this or the withFrom(String) is specified, any offset paging parameters set via withPage(int, int) or withTotals(boolean) will be disregarded by the API.

      Parameters:
      take - the amount of entries to retrieve per page.
      Returns:
      this filter instance.