Package zendesk.support

Class ListArticleQuery


  • public class ListArticleQuery
extends java.lang.Object
    This class encapsulates the parameters for listing Articles in Help Center.

    This class is what is used when searching Help Center with a HelpCenterProvider, specifically with the HelpCenterProvider#listArticles(ListArticleQuery, ZendeskCallback) method

    See Also:
    Listing Articles in Help Center

    • Constructor Summary

      Constructors 
      Constructor and Description
      ListArticleQuery() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getInclude()
      Gets the includes for this query
      java.lang.String getLabelNames()
      Gets the label names for this query as a CSV string
      java.util.Locale getLocale()
      Gets the locale for this query
      java.lang.Integer getPage()
      Gets the page for this query
      java.lang.Integer getResultsPerPage()
      Gets the results per page for this query
      SortBy getSortBy()
      Gets the sort method for this query
      SortOrder getSortOrder()
      Gets the sort order for this query
      void setInclude(java.lang.String include)
      Sets the includes for this query
      void setLabelNames(java.lang.String labelNames)
      Sets the label names to include in the query as a CSV string
      void setLocale(java.util.Locale locale)
      Sets the locale for this query
      void setPage(java.lang.Integer page)
      Specifies the page for this query
      void setResultsPerPage(java.lang.Integer resultsPerPage)
      Specifies the number of results per page for this query
      void setSortBy(SortBy sortBy)
      Sets the sort method for this query
      void setSortOrder(SortOrder sortOrder)
      Specifies the sort order for this query

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ListArticleQuery

        public ListArticleQuery()

    • Method Detail

      • getLabelNames

        public java.lang.String getLabelNames()
        Gets the label names for this query as a CSV string
        Returns:
        The label names for this query as a CSV string

      • getLocale

        public java.util.Locale getLocale()
        Gets the locale for this query
        Returns:
        The locale for this query

      • getInclude

        public java.lang.String getInclude()
        Gets the includes for this query
        Returns:
        The includes for this query

      • getSortBy

        public SortBy getSortBy()
        Gets the sort method for this query
        Returns:
        The sort method for this query

      • getSortOrder

        public SortOrder getSortOrder()
        Gets the sort order for this query
        Returns:
        The sort order for this query

      • getPage

        public java.lang.Integer getPage()
        Gets the page for this query
        Returns:
        The page for this query

      • getResultsPerPage

        public java.lang.Integer getResultsPerPage()
        Gets the results per page for this query
        Returns:
        The results per page for this query

      • setLabelNames

        public void setLabelNames(java.lang.String labelNames)
        Sets the label names to include in the query as a CSV string

        e.g. "label1" or "label1,label2,label3"

        Parameters:
        labelNames - The label names to include in the query as a CSV string

      • setLocale

        public void setLocale(java.util.Locale locale)
        Sets the locale for this query
        Parameters:
        locale - the locale to set for this query

      • setInclude

        public void setInclude(java.lang.String include)
        Sets the includes for this query
        Parameters:
        include - The includes for this query

      • setSortBy

        public void setSortBy(SortBy sortBy)
        Sets the sort method for this query
        Parameters:
        sortBy - the sort method for this query

      • setSortOrder

        public void setSortOrder(SortOrder sortOrder)
        Specifies the sort order for this query
        Parameters:
        sortOrder - the sort order for this query

      • setPage

        public void setPage(java.lang.Integer page)
        Specifies the page for this query
        Parameters:
        page - The page for this query

      • setResultsPerPage

        public void setResultsPerPage(java.lang.Integer resultsPerPage)
        Specifies the number of results per page for this query
        Parameters:
        resultsPerPage - The number of results per page for this query