Package zendesk.support

Class HelpRequest


  • public class HelpRequest
extends java.lang.Object
    Models a request for a flattened view of Help Center

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  HelpRequest.Builder
      This builder is used to create a HelpRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int getArticlesPerPageLimit()
      Gets the maximum number of articles per page
      java.lang.String getCategoryIds()
      Gets the category IDs as a CSV string
      java.lang.String getIncludes()
      Gets the includes (side-loads) as a CSV string
      java.lang.String[] getLabelNames()
      Gets the label names to which the search will be restricted.
      java.lang.String getSectionIds()
      Gets the section IDs as a CSV string

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getCategoryIds

        public java.lang.String getCategoryIds()
        Gets the category IDs as a CSV string
        Returns:
        the category IDs as a CSV string

      • getSectionIds

        public java.lang.String getSectionIds()
        Gets the section IDs as a CSV string
        Returns:
        the section IDs as a CSV string

      • getIncludes

        public java.lang.String getIncludes()
        Gets the includes (side-loads) as a CSV string
        Returns:
        the Gets the includes (side-loads) as a CSV string

      • getArticlesPerPageLimit

        public int getArticlesPerPageLimit()
        Gets the maximum number of articles per page
        Returns:
        the maximum number of articles per page

      • getLabelNames

        public java.lang.String[] getLabelNames()
        Gets the label names to which the search will be restricted.
        Returns:
        the array of label names