Package zendesk.support

Class HelpCenterSearch

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class HelpCenterSearch
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
    This class encapsulates the parameters for searching Help Center.

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

    See Also:
    Searching Help Center, Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getCategoryIds()
      Returns the category IDs to specify
      java.lang.String getInclude()
      Returns the includes to specify.
      java.lang.String getLabelNames()
      Returns the label names to specify.
      java.util.Locale getLocale()
      Returns the locale to search in
      java.lang.Integer getPage()
      Returns the page to specify
      java.lang.Integer getPerPage()
      The amount of results per page to specify
      java.lang.String getQuery()
      Returns the free-form text query
      java.lang.String getSectionIds()
      Returns the section IDs to specify
      HelpCenterSearch withQuery(java.lang.String query)
      Clones the current search and sets the query on it

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getQuery

        public java.lang.String getQuery()
        Returns the free-form text query
        Returns:
        the query

      • getLocale

        public java.util.Locale getLocale()
        Returns the locale to search in
        Returns:
        the locale to search in

      • getInclude

        public java.lang.String getInclude()
        Returns the includes to specify. (a.k.a side-loads)
        Returns:
        the includes to specify

      • getLabelNames

        public java.lang.String getLabelNames()
        Returns the label names to specify.
        Returns:
        the label names to specify

      • getCategoryIds

        public java.lang.String getCategoryIds()
        Returns the category IDs to specify
        Returns:
        the category IDs to specify

      • getSectionIds

        public java.lang.String getSectionIds()
        Returns the section IDs to specify
        Returns:
        the section IDs to specify

      • getPage

        public java.lang.Integer getPage()
        Returns the page to specify
        Returns:
        the page to specify

      • getPerPage

        public java.lang.Integer getPerPage()
        The amount of results per page to specify
        Returns:
        the amount of results per page to specify

      • withQuery

        public HelpCenterSearch withQuery(java.lang.String query)
        Clones the current search and sets the query on it
        Parameters:
        query - The query to set
        Returns:
        a clone of the current search with the query set