Class ArticleListItem.Builder
- All Implemented Interfaces:
ArticleListItem._FinalStage,ArticleListItem.AuthorIdStage,ArticleListItem.CreatedAtStage,ArticleListItem.DefaultLocaleStage,ArticleListItem.IdStage,ArticleListItem.StateStage,ArticleListItem.TitleStage,ArticleListItem.TranslatedContentStage,ArticleListItem.UpdatedAtStage,ArticleListItem.WorkspaceIdStage
- Enclosing class:
ArticleListItem
-
Method Summary
Modifier and TypeMethodDescriptionauthorId(int authorId) The id of the author of the article.The body of the article in HTML.build()createdAt(int createdAt) The time when the article was created.defaultLocale(String defaultLocale) The default locale of the help center.description(String description) The description of the article.description(Optional<String> description) from(ArticleListItem other) The unique identifier for the article which is given by Intercom.The id of the article's parent collection or section.The ids of the article's parent collections or sections.parentType(String parentType) The type of parent, which can either be acollectionorsection.parentType(Optional<String> parentType) state(ArticleListItem.State state) Whether the article ispublishedor is adraft.The title of the article.translatedContent(ArticleTranslatedContent translatedContent) The type of object -article.updatedAt(int updatedAt) The time when the article was last updated.The URL of the article.workspaceId(String workspaceId) The id of the workspace which the article belongs to.
-
Method Details
-
from
- Specified by:
fromin interfaceArticleListItem.IdStage
-
id
The unique identifier for the article which is given by Intercom.
- Specified by:
idin interfaceArticleListItem.IdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
workspaceId
The id of the workspace which the article belongs to.
- Specified by:
workspaceIdin interfaceArticleListItem.WorkspaceIdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
title
The title of the article. For multilingual articles, this will be the title of the default language's content.
- Specified by:
titlein interfaceArticleListItem.TitleStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
authorId
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.
- Specified by:
authorIdin interfaceArticleListItem.AuthorIdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
state
Whether the article is
publishedor is adraft. For multilingual articles, this will be the state of the default language's content.- Specified by:
statein interfaceArticleListItem.StateStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
createdAt
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.
- Specified by:
createdAtin interfaceArticleListItem.CreatedAtStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
updatedAt
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.
- Specified by:
updatedAtin interfaceArticleListItem.UpdatedAtStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
defaultLocale
The default locale of the help center. This field is only returned for multilingual help centers.
- Specified by:
defaultLocalein interfaceArticleListItem.DefaultLocaleStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
translatedContent
public ArticleListItem._FinalStage translatedContent(@NotNull ArticleTranslatedContent translatedContent) - Specified by:
translatedContentin interfaceArticleListItem.TranslatedContentStage
-
parentType
The type of parent, which can either be a
collectionorsection.- Specified by:
parentTypein interfaceArticleListItem._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
parentType
- Specified by:
parentTypein interfaceArticleListItem._FinalStage
-
parentIds
The ids of the article's parent collections or sections. An article without this field stands alone.
- Specified by:
parentIdsin interfaceArticleListItem._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
parentIds
- Specified by:
parentIdsin interfaceArticleListItem._FinalStage
-
parentId
The id of the article's parent collection or section. An article without this field stands alone.
- Specified by:
parentIdin interfaceArticleListItem._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
parentId
- Specified by:
parentIdin interfaceArticleListItem._FinalStage
-
url
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
- Specified by:
urlin interfaceArticleListItem._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
url
- Specified by:
urlin interfaceArticleListItem._FinalStage
-
body
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
- Specified by:
bodyin interfaceArticleListItem._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
body
- Specified by:
bodyin interfaceArticleListItem._FinalStage
-
description
The description of the article. For multilingual articles, this will be the description of the default language's content.
- Specified by:
descriptionin interfaceArticleListItem._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
description
- Specified by:
descriptionin interfaceArticleListItem._FinalStage
-
type
The type of object -
article.- Specified by:
typein interfaceArticleListItem._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
type
- Specified by:
typein interfaceArticleListItem._FinalStage
-
build
- Specified by:
buildin interfaceArticleListItem._FinalStage
-