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

Class Article.Builder

java.lang.Object

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

All Implemented Interfaces:

Article._FinalStage, Article.AuthorIdStage, Article.CreatedAtStage, Article.DefaultLocaleStage, Article.IdStage, Article.StateStage, Article.TitleStage, Article.TranslatedContentStage, Article.UpdatedAtStage, Article.WorkspaceIdStage

Enclosing class:

Article

public static final class Article.Builder
extends Object
implements Article.IdStage, Article.WorkspaceIdStage, Article.TitleStage, Article.AuthorIdStage, Article.StateStage, Article.CreatedAtStage, Article.UpdatedAtStage, Article.DefaultLocaleStage, Article.TranslatedContentStage, Article._FinalStage

Method Summary

Modifier and Type	Method	Description
Article.StateStage	authorId(int authorId)	The id of the author of the article.
Article._FinalStage	body(String body)	The body of the article in HTML.
Article._FinalStage	body(Optional<String> body)
Article	build()
Article.UpdatedAtStage	createdAt(int createdAt)	The time when the article was created.
Article.TranslatedContentStage	defaultLocale(String defaultLocale)	The default locale of the help center.
Article._FinalStage	description(String description)	The description of the article.
Article._FinalStage	description(Optional<String> description)
Article.Builder	from(Article other)
Article.WorkspaceIdStage	id(String id)	The unique identifier for the article which is given by Intercom.
Article._FinalStage	parentId(Integer parentId)	The id of the article's parent collection or section.
Article._FinalStage	parentId(Optional<Integer> parentId)
Article._FinalStage	parentIds(List<Integer> parentIds)	The ids of the article's parent collections or sections.
Article._FinalStage	parentIds(Optional<List<Integer>> parentIds)
Article._FinalStage	parentType(String parentType)	The type of parent, which can either be a collection or section.
Article._FinalStage	parentType(Optional<String> parentType)
Article.CreatedAtStage	state(Article.State state)	Whether the article is published or is a draft.
Article._FinalStage	statistics(ArticleStatistics statistics)
Article._FinalStage	statistics(Optional<ArticleStatistics> statistics)
Article.AuthorIdStage	title(String title)	The title of the article.
Article._FinalStage	translatedContent(ArticleTranslatedContent translatedContent)
Article._FinalStage	type(String type)	The type of object - article.
Article._FinalStage	type(Optional<String> type)
Article.DefaultLocaleStage	updatedAt(int updatedAt)	The time when the article was last updated.
Article._FinalStage	url(String url)	The URL of the article.
Article._FinalStage	url(Optional<String> url)
Article.TitleStage	workspaceId(String workspaceId)	The id of the workspace which the article belongs to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public Article.Builder from(Article other)

Specified by:

from in interface Article.IdStage

id

public Article.WorkspaceIdStage id(@NotNull
 String id)

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

Specified by:

id in interface Article.IdStage

Returns:

Reference to this so that method calls can be chained together.

workspaceId

public Article.TitleStage workspaceId(@NotNull
 String workspaceId)

The id of the workspace which the article belongs to.

Specified by:

workspaceId in interface Article.WorkspaceIdStage

Returns:

Reference to this so that method calls can be chained together.

title

public Article.AuthorIdStage title(@NotNull
 String title)

The title of the article. For multilingual articles, this will be the title of the default language's content.

Specified by:

title in interface Article.TitleStage

Returns:

Reference to this so that method calls can be chained together.

authorId

public Article.StateStage authorId(int 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:

authorId in interface Article.AuthorIdStage

Returns:

Reference to this so that method calls can be chained together.

state

public Article.CreatedAtStage state(@NotNull
 Article.State state)

Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

Specified by:

state in interface Article.StateStage

Returns:

Reference to this so that method calls can be chained together.

createdAt

public Article.UpdatedAtStage createdAt(int 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:

createdAt in interface Article.CreatedAtStage

Returns:

Reference to this so that method calls can be chained together.

updatedAt

public Article.DefaultLocaleStage updatedAt(int 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:

updatedAt in interface Article.UpdatedAtStage

Returns:

Reference to this so that method calls can be chained together.

defaultLocale

public Article.TranslatedContentStage defaultLocale(@NotNull
 String defaultLocale)

The default locale of the help center. This field is only returned for multilingual help centers.

Specified by:

defaultLocale in interface Article.DefaultLocaleStage

Returns:

Reference to this so that method calls can be chained together.

translatedContent

public Article._FinalStage translatedContent(@NotNull
 ArticleTranslatedContent translatedContent)

Specified by:

translatedContent in interface Article.TranslatedContentStage

statistics

public Article._FinalStage statistics(ArticleStatistics statistics)

Specified by:

statistics in interface Article._FinalStage

statistics

public Article._FinalStage statistics(Optional<ArticleStatistics> statistics)

Specified by:

statistics in interface Article._FinalStage

parentType

public Article._FinalStage parentType(String parentType)

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

Specified by:

parentType in interface Article._FinalStage

Returns:

Reference to this so that method calls can be chained together.

parentType

public Article._FinalStage parentType(Optional<String> parentType)

Specified by:

parentType in interface Article._FinalStage

parentIds

public Article._FinalStage parentIds(List<Integer> parentIds)

The ids of the article's parent collections or sections. An article without this field stands alone.

Specified by:

parentIds in interface Article._FinalStage

Returns:

Reference to this so that method calls can be chained together.

parentIds

public Article._FinalStage parentIds(Optional<List<Integer>> parentIds)

Specified by:

parentIds in interface Article._FinalStage

parentId

public Article._FinalStage parentId(Integer parentId)

The id of the article's parent collection or section. An article without this field stands alone.

Specified by:

parentId in interface Article._FinalStage

Returns:

Reference to this so that method calls can be chained together.

parentId

public Article._FinalStage parentId(Optional<Integer> parentId)

Specified by:

parentId in interface Article._FinalStage

url

public Article._FinalStage url(String url)

The URL of the article. For multilingual articles, this will be the URL of the default language's content.

Specified by:

url in interface Article._FinalStage

Returns:

Reference to this so that method calls can be chained together.

url

public Article._FinalStage url(Optional<String> url)

Specified by:

url in interface Article._FinalStage

body

public Article._FinalStage body(String body)

The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

Specified by:

body in interface Article._FinalStage

Returns:

Reference to this so that method calls can be chained together.

body

public Article._FinalStage body(Optional<String> body)

Specified by:

body in interface Article._FinalStage

description

public Article._FinalStage description(String description)

The description of the article. For multilingual articles, this will be the description of the default language's content.

Specified by:

description in interface Article._FinalStage

Returns:

Reference to this so that method calls can be chained together.

description

public Article._FinalStage description(Optional<String> description)

Specified by:

description in interface Article._FinalStage

type

public Article._FinalStage type(String type)

The type of object - article.

Specified by:

type in interface Article._FinalStage

Returns:

Reference to this so that method calls can be chained together.

type

public Article._FinalStage type(Optional<String> type)

Specified by:

type in interface Article._FinalStage

build

public Article build()

Specified by:

build in interface Article._FinalStage