Class SuggestedArticleSearch.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • withQuery

        public SuggestedArticleSearch.Builder withQuery(java.lang.String query)
        Specifies the free-form query to perform.
        Parameters:
        query - The free-form query to perform
        Returns:
        The Builder
      • forLocale

        public SuggestedArticleSearch.Builder forLocale(java.util.Locale locale)
        Specifies the locale to perform the search in. Note that this must be a supported locale by your Help Center instance
        Parameters:
        locale - The locale to search in
        Returns:
        The Builder
      • withLabelNames

        public SuggestedArticleSearch.Builder withLabelNames(java.lang.String... labelNames)
        Specifies the label names to restrict the results to. Note that ALL label names must match for an article to be includes in the search results.
        Parameters:
        labelNames - The label names to restrict the results to
        Returns:
        The builder
      • withCategoryId

        public SuggestedArticleSearch.Builder withCategoryId(java.lang.Long categoryId)
        Specifies the category id to restrict the results to.
        Parameters:
        categoryId - The category id to restrict the results to
        Returns:
        The builder
      • withSectionId

        public SuggestedArticleSearch.Builder withSectionId(java.lang.Long sectionId)
        Specifies the section id to restrict the results to.
        Parameters:
        sectionId - The section id to restrict the results to
        Returns:
        The builder