Class Collection


  • public final class Collection
    extends java.lang.Object
    • Method Detail

      • getId

        public java.util.Optional<java.lang.String> getId()
        Returns:
        The unique identifier for the collection which is given by Intercom.
      • getWorkspaceId

        public java.util.Optional<java.lang.String> getWorkspaceId()
        Returns:
        The id of the workspace which the collection belongs to.
      • getName

        public java.util.Optional<java.lang.String> getName()
        Returns:
        The name of the collection. For multilingual collections, this will be the name of the default language's content.
      • getDescription

        public java.util.Optional<java.lang.String> getDescription()
        Returns:
        The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
      • getCreatedAt

        public java.util.Optional<java.lang.Integer> getCreatedAt()
        Returns:
        The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
      • getUpdatedAt

        public java.util.Optional<java.lang.Integer> getUpdatedAt()
        Returns:
        The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.
      • getUrl

        public java.util.Optional<java.lang.String> getUrl()
        Returns:
        The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
      • getIcon

        public java.util.Optional<java.lang.String> getIcon()
        Returns:
        The icon of the collection.
      • getOrder

        public java.util.Optional<java.lang.Integer> getOrder()
        Returns:
        The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.
      • getDefaultLocale

        public java.util.Optional<java.lang.String> getDefaultLocale()
        Returns:
        The default locale of the help center. This field is only returned for multilingual help centers.
      • getParentId

        public java.util.Optional<java.lang.String> getParentId()
        Returns:
        The id of the parent collection. If null then it is the first level collection.
      • getHelpCenterId

        public java.util.Optional<java.lang.Integer> getHelpCenterId()
        Returns:
        The id of the help center the collection is in.
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object