Package zendesk.support

Class Section

  • All Implemented Interfaces:
    java.io.Serializable

    public class Section
extends java.lang.Object
implements java.io.Serializable
    This is a model class for a Section object that will be created by the HelpCenterProvider.
    See Also:
    Sections, Serialized Form

    • Constructor Summary

      Constructors 
      Constructor and Description
      Section() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int getArticlesCount()
      Gets the number of articles in this section
      java.lang.Long getCategoryId()
      Gets the id of the Category that this section belongs to
      java.util.Date getCreatedAt()
      Gets the date that the section was created at
      java.lang.String getDescription()
      Gets the description of the section
      java.lang.String getHtmlUrl()
      Gets the html URL of the section, which can be used to open the section in a web browser
      java.lang.Long getId()
      Gets the ID of the section
      java.lang.String getLocale()
      Gets the locale of the section in the form of ll-CC, e.g.
      java.lang.String getName()
      Gets the name of the section
      int getPosition()
      Gets the sorting position of the section.
      java.lang.String getSorting()
      Gets the sorting of the section, e.g.
      java.lang.String getSourceLocale()
      Gets the source locale of the section in the form of ll-CC, e.g.
      java.util.Date getUpdatedAt()
      Gets the date that the section was updated at
      java.lang.String getUrl()
      Gets the API URL of the section
      boolean isOutdated()
      Checks whether the section is outdated or not

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Section

        public Section()

    • Method Detail

      • getId

        public java.lang.Long getId()
        Gets the ID of the section
        Returns:
        the ID of the section

      • getUrl

        public java.lang.String getUrl()
        Gets the API URL of the section
        Returns:
        the API URL of the section

      • getHtmlUrl

        public java.lang.String getHtmlUrl()
        Gets the html URL of the section, which can be used to open the section in a web browser
        Returns:
        the html URL of the section

      • getCategoryId

        public java.lang.Long getCategoryId()
        Gets the id of the Category that this section belongs to
        Returns:
        the id of the Category that this section belongs to

      • getPosition

        public int getPosition()
        Gets the sorting position of the section. Only applicable if the sections are manually sorted in the category.
        Returns:
        the sorting position of the section

      • getSorting

        public java.lang.String getSorting()
        Gets the sorting of the section, e.g. 'manual'
        Returns:
        the sorting of the section

      • getCreatedAt

        public java.util.Date getCreatedAt()
        Gets the date that the section was created at
        Returns:
        the date that the section was created at

      • getUpdatedAt

        public java.util.Date getUpdatedAt()
        Gets the date that the section was updated at
        Returns:
        the date that the section was updated at

      • getName

        public java.lang.String getName()
        Gets the name of the section
        Returns:
        the name of the section

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the section
        Returns:
        the description of the section

      • getLocale

        public java.lang.String getLocale()
        Gets the locale of the section in the form of ll-CC, e.g. en-US
        Returns:
        the locale of the section in the form of ll-CC, e.g. en-US

      • getSourceLocale

        public java.lang.String getSourceLocale()
        Gets the source locale of the section in the form of ll-CC, e.g. en-US
        Returns:
        the source locale of the section in the form of ll-CC, e.g. en-US

      • isOutdated

        public boolean isOutdated()
        Checks whether the section is outdated or not
        Returns:
        true if the section is outdated, false otherwise

      • getArticlesCount

        public int getArticlesCount()
        Gets the number of articles in this section
        Returns:
        the number of articles in this section