Package com.intercom.api.resources.articles.types

Class ArticleListItem

java.lang.Object
com.intercom.api.resources.articles.types.ArticleListItem
All Implemented Interfaces:
IArticleListItem
public final class ArticleListItem extends Object implements IArticleListItem

  • Method Details

    • getType

      public Optional<String> getType()
      Specified by:
      getType in interface IArticleListItem
      Returns:
      The type of object - article.

    • getId

      public String getId()
      Specified by:
      getId in interface IArticleListItem
      Returns:
      The unique identifier for the article which is given by Intercom.

    • getWorkspaceId

      public String getWorkspaceId()
      Specified by:
      getWorkspaceId in interface IArticleListItem
      Returns:
      The id of the workspace which the article belongs to.

    • getTitle

      public String getTitle()
      Specified by:
      getTitle in interface IArticleListItem
      Returns:
      The title of the article. For multilingual articles, this will be the title of the default language's content.

    • getDescription

      public Optional<String> getDescription()
      Specified by:
      getDescription in interface IArticleListItem
      Returns:
      The description of the article. For multilingual articles, this will be the description of the default language's content.

    • getBody

      public Optional<String> getBody()
      Specified by:
      getBody in interface IArticleListItem
      Returns:
      The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

    • getAuthorId

      public int getAuthorId()
      Specified by:
      getAuthorId in interface IArticleListItem
      Returns:
      The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

    • getState

      public ArticleListItem.State getState()
      Returns:
      Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

    • getCreatedAt

      public int getCreatedAt()
      Specified by:
      getCreatedAt in interface IArticleListItem
      Returns:
      The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.

    • getUpdatedAt

      public int getUpdatedAt()
      Specified by:
      getUpdatedAt in interface IArticleListItem
      Returns:
      The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.

    • getUrl

      public Optional<String> getUrl()
      Specified by:
      getUrl in interface IArticleListItem
      Returns:
      The URL of the article. For multilingual articles, this will be the URL of the default language's content.

    • getParentId

      public Optional<Integer> getParentId()
      Specified by:
      getParentId in interface IArticleListItem
      Returns:
      The id of the article's parent collection or section. An article without this field stands alone.

    • getParentIds

      public Optional<List<Integer>> getParentIds()
      Specified by:
      getParentIds in interface IArticleListItem
      Returns:
      The ids of the article's parent collections or sections. An article without this field stands alone.

    • getParentType

      public Optional<String> getParentType()
      Specified by:
      getParentType in interface IArticleListItem
      Returns:
      The type of parent, which can either be a collection or section.

    • getDefaultLocale

      public String getDefaultLocale()
      Specified by:
      getDefaultLocale in interface IArticleListItem
      Returns:
      The default locale of the help center. This field is only returned for multilingual help centers.

    • getTranslatedContent

      public ArticleTranslatedContent getTranslatedContent()
      Specified by:
      getTranslatedContent in interface IArticleListItem

    • 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 ArticleListItem.IdStage builder()