Package com.auth0.client.mgmt.filter

Class InvitationsFilter

java.lang.Object
com.auth0.client.mgmt.filter.BaseFilter
com.auth0.client.mgmt.filter.InvitationsFilter
public class InvitationsFilter extends BaseFilter
Class used to filter the results received when fetching invitations. Related to the OrganizationsEntity.

This class is not thread-safe.

  • Constructor Details

    • InvitationsFilter

      public InvitationsFilter()

  • Method Details

    • withPage

      public InvitationsFilter 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 InvitationsFilter withTotals(boolean includeTotals)
      Include the query summary
      Parameters:
      includeTotals - whether to include or not the query summary.
      Returns:
      this filter instance

    • withFields

      public InvitationsFilter withFields(String fields, boolean includeFields)
      Only retrieve certain fields from the item.
      Parameters:
      fields - a list of comma separated fields to retrieve.
      includeFields - whether to include or exclude in the response the fields that were given.
      Returns:
      this filter instance

    • withSort

      public InvitationsFilter withSort(String sort)
      Sort the query
      Parameters:
      sort - the field to use for sorting. Use 'field:order' where order is 1 for ascending and -1 for descending.
      Returns:
      this filter instance