Class FindCommunitiesRequest.Builder

    • Field Detail

      • offset

        @Deprecated(forRemoval=true)
        protected int offset
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use cursor pagination.
      • limit

        @Deprecated
        protected int limit
        Deprecated.
        This field will become private in the next major release.
    • Method Detail

      • offset

        @Deprecated(forRemoval=true)
        public FindCommunitiesRequest.Builder offset​(int offset)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use cursor pagination.
      • cursor

        public FindCommunitiesRequest.Builder cursor​(String cursor)
        Parameters:
        cursor - Cursor for the current page of results. To retrieve the first page with cursor pagination you need to pass this parameter with an empty value (must be non-null). For the next pages, the value must be taken from the response (nextCursor property).
        Returns:
        this.
      • nameMatchMode

        public FindCommunitiesRequest.Builder nameMatchMode​(MatchMode nameMatchMode)
        Parameters:
        nameMatchMode - The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive." When omitted, the nameMatchMode defaults to ANYWHERE.
        Returns:
        this.
      • parentId

        public FindCommunitiesRequest.Builder parentId​(UUID parentId)
        Parameters:
        parentId - The ID of the parent community to find the communities in.
        Returns:
        this.
      • excludeMeta

        public FindCommunitiesRequest.Builder excludeMeta​(boolean excludeMeta)
        Parameters:
        excludeMeta - The exclude meta flag. If this is set to true then the meta communities will not be returned (meta communities are i.e. communities not created manually by the user). When omitted, the excludeMeta flag defaults to true.
        Returns:
        this.
      • toString

        public String toString()
        Overrides:
        toString in class Object