Package zendesk.support

Class Category

  • All Implemented Interfaces:
    java.io.Serializable

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

    • Constructor Summary

      Constructors 
      Constructor and Description
      Category() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Date getCreatedAt()
      Gets the date that the category was created at.
      java.lang.String getDescription()
      Gets the description of the category
      java.lang.String getHtmlUrl()
      Gets the URL of the category that can be opened in a web browser
      java.lang.Long getId()
      Gets the ID of the category
      java.lang.String getLocale()
      Gets the locale of the category in the form of ll-CC, e.g.
      java.lang.String getName()
      Gets the name of the category
      int getPosition()
      Gets the position of the category.
      java.lang.String getSourceLocale()
      Gets the source locale of the category in the form of ll-CC, e.g.
      java.util.Date getUpdatedAt()
      Gets the date that the category was updated at.
      java.lang.String getUrl()
      Gets the API URL of the category
      boolean isOutdated()
      Checks whether the category is outdated or not

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Category

        public Category()

    • Method Detail

      • getId

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

      • getUrl

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

      • getHtmlUrl

        public java.lang.String getHtmlUrl()
        Gets the URL of the category that can be opened in a web browser
        Returns:
        the URL of the category that can be opened in a web browser

      • getPosition

        public int getPosition()
        Gets the position of the category. This is applicable if the categories are manually sorted.
        Returns:
        the position of the category

      • getCreatedAt

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

      • getUpdatedAt

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

      • getName

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

      • getDescription

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

      • getLocale

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

      • getSourceLocale

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

      • isOutdated

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