Package zendesk.support

Class HelpCenterSearch.Builder

  • Enclosing class:
    HelpCenterSearch

    public static class HelpCenterSearch.Builder
extends java.lang.Object
    This is a builder class which is used to generate a HelpCenterSearch

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • withQuery

        public HelpCenterSearch.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 HelpCenterSearch.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

      • withIncludes

        public HelpCenterSearch.Builder withIncludes(java.lang.String... includes)
        Specifies the includes to be returned by the search.
        Parameters:
        includes - The includes to be returned by the search
        Returns:
        The Builder
        See Also:
        Includes documentation

      • withLabelNames

        public HelpCenterSearch.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 HelpCenterSearch.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

      • withCategoryIds

        public HelpCenterSearch.Builder withCategoryIds(java.util.List<java.lang.Long> categoryIds)
        Specifies the category IDs to restrict the results to.
        Parameters:
        categoryIds - The category IDs to restrict the results to
        Returns:
        The builder

      • withSectionId

        public HelpCenterSearch.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

      • withSectionIds

        public HelpCenterSearch.Builder withSectionIds(java.util.List<java.lang.Long> sectionIds)
        Specifies the section IDs to restrict the results to.
        Parameters:
        sectionIds - The section IDs to restrict the results to
        Returns:
        The builder

      • page

        public HelpCenterSearch.Builder page(java.lang.Integer page)
        Specifies which page of results to request.
        Parameters:
        page - The page of results to request
        Returns:
        the builder

      • perPage

        public HelpCenterSearch.Builder perPage(java.lang.Integer perPage)
        Specifies the number of results to display per page
        Parameters:
        perPage - The number of results to display per page
        Returns:
        the builder