Package com.intercom.api.resources.helpcenter.types

Class Collection

java.lang.Object
com.intercom.api.resources.helpcenter.types.Collection
public final class Collection extends Object

  • Method Details

    • getId

      public String getId()
      Returns:
      The unique identifier for the collection which is given by Intercom.

    • getWorkspaceId

      public String getWorkspaceId()
      Returns:
      The id of the workspace which the collection belongs to.

    • getName

      public String getName()
      Returns:
      The name of the collection. For multilingual collections, this will be the name of the default language's content.

    • getDescription

      public Optional<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 int 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 Optional<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 Optional<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 Optional<String> getIcon()
      Returns:
      The icon of the collection.

    • getOrder

      public int 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 String getDefaultLocale()
      Returns:
      The default locale of the help center. This field is only returned for multilingual help centers.

    • getTranslatedContent

      public Optional<GroupTranslatedContent> getTranslatedContent()

    • getParentId

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

    • getHelpCenterId

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

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static Collection.IdStage builder()