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

Class Article

java.lang.Object

com.intercom.api.resources.articles.types.Article

All Implemented Interfaces:

IArticleListItem

public final class Article
extends java.lang.Object
implements IArticleListItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Article._FinalStage
static interface	Article.AuthorIdStage
static class	Article.Builder
static interface	Article.CreatedAtStage
static interface	Article.IdStage
static class	Article.State
static interface	Article.StateStage
static interface	Article.TitleStage
static interface	Article.UpdatedAtStage
static interface	Article.WorkspaceIdStage

Method Summary

Modifier and Type	Method	Description
static Article.IdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
int	getAuthorId()
java.util.Optional<java.lang.String>	getBody()
int	getCreatedAt()
java.util.Optional<java.lang.String>	getDefaultLocale()
java.util.Optional<java.lang.String>	getDescription()
java.lang.String	getId()
java.util.Optional<java.lang.Integer>	getParentId()
java.util.Optional<java.util.List<java.lang.Integer>>	getParentIds()
java.util.Optional<java.lang.String>	getParentType()
Article.State	getState()
java.util.Optional<ArticleStatistics>	getStatistics()
java.lang.String	getTitle()
java.util.Optional<ArticleTranslatedContent>	getTranslatedContent()
java.util.Optional<java.lang.String>	getType()
int	getUpdatedAt()
java.util.Optional<java.lang.String>	getUrl()
java.lang.String	getWorkspaceId()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getType

public java.util.Optional<java.lang.String> getType()

Specified by:

getType in interface IArticleListItem

Returns:

The type of object - article.

getId

public java.lang.String getId()

Specified by:

getId in interface IArticleListItem

Returns:

The unique identifier for the article which is given by Intercom.

getWorkspaceId

public java.lang.String getWorkspaceId()

Specified by:

getWorkspaceId in interface IArticleListItem

Returns:

The id of the workspace which the article belongs to.

getTitle

public java.lang.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 java.util.Optional<java.lang.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 java.util.Optional<java.lang.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 Article.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 java.util.Optional<java.lang.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 java.util.Optional<java.lang.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 java.util.Optional<java.util.List<java.lang.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 java.util.Optional<java.lang.String> getParentType()

Specified by:

getParentType in interface IArticleListItem

Returns:

The type of parent, which can either be a collection or section.

getDefaultLocale

public java.util.Optional<java.lang.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 java.util.Optional<ArticleTranslatedContent> getTranslatedContent()

Specified by:

getTranslatedContent in interface IArticleListItem

getStatistics

public java.util.Optional<ArticleStatistics> getStatistics()

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

builder

public static Article.IdStage builder()