Package zendesk.support

Class HelpRequest.Builder

  • Enclosing class:
    HelpRequest

    public static class HelpRequest.Builder
extends java.lang.Object
    This builder is used to create a HelpRequest

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • withCategoryIds

        public HelpRequest.Builder withCategoryIds(java.util.List<java.lang.Long> ids)
        Specifies the category IDs to include in the request
        Parameters:
        ids - The category IDs to include in the request
        Returns:
        the builder

      • withSectionIds

        public HelpRequest.Builder withSectionIds(java.util.List<java.lang.Long> ids)
        Specifies the section IDs to include in the request
        Parameters:
        ids - The section IDs to include in the request
        Returns:
        the builder

      • includeCategories

        public HelpRequest.Builder includeCategories()
        Specifies that categories should be included as a side-load
        Returns:
        the builder

      • includeSections

        public HelpRequest.Builder includeSections()
        Specifies that sections should be included as a side-load
        Returns:
        the builder

      • withArticlesPerSectionLimit

        public HelpRequest.Builder withArticlesPerSectionLimit(int articlesPerSection)
        Specifies the maximum number of articles to request per section
        Parameters:
        articlesPerSection - The maximum number of articles to request per section
        Returns:
        the builder

      • withLabelNames

        public HelpRequest.Builder withLabelNames(java.lang.String... labelNames)
        Specifies the label names to which the search will be restricted.
        Parameters:
        labelNames - The label names to be used to filter the search results.
        Returns:
        the builder