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

Class ArticleListItem.Builder

java.lang.Object

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

All Implemented Interfaces:

ArticleListItem._FinalStage, ArticleListItem.AuthorIdStage, ArticleListItem.CreatedAtStage, ArticleListItem.IdStage, ArticleListItem.StateStage, ArticleListItem.TitleStage, ArticleListItem.UpdatedAtStage, ArticleListItem.WorkspaceIdStage

Enclosing class:

ArticleListItem

public static final class ArticleListItem.Builder
extends java.lang.Object
implements ArticleListItem.IdStage, ArticleListItem.WorkspaceIdStage, ArticleListItem.TitleStage, ArticleListItem.AuthorIdStage, ArticleListItem.StateStage, ArticleListItem.CreatedAtStage, ArticleListItem.UpdatedAtStage, ArticleListItem._FinalStage

Method Summary

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

from

public ArticleListItem.Builder from(ArticleListItem other)

Specified by:

from in interface ArticleListItem.IdStage

id

public ArticleListItem.WorkspaceIdStage id(@NotNull
                                           java.lang.String id)

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

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

Specified by:

id in interface ArticleListItem.IdStage

Returns:

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

workspaceId

public ArticleListItem.TitleStage workspaceId(@NotNull
                                              java.lang.String workspaceId)

The id of the workspace which the article belongs to.

The id of the workspace which the article belongs to.

Specified by:

workspaceId in interface ArticleListItem.WorkspaceIdStage

Returns:

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

title

public ArticleListItem.AuthorIdStage title(@NotNull
                                           java.lang.String title)

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

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

Specified by:

title in interface ArticleListItem.TitleStage

Returns:

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

authorId

public ArticleListItem.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.

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 ArticleListItem.AuthorIdStage

Returns:

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

state

public ArticleListItem.CreatedAtStage state(@NotNull
                                            ArticleListItem.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.

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 ArticleListItem.StateStage

Returns:

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

createdAt

public ArticleListItem.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.

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 ArticleListItem.CreatedAtStage

Returns:

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

updatedAt

public ArticleListItem._FinalStage 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.

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 ArticleListItem.UpdatedAtStage

Returns:

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

translatedContent

public ArticleListItem._FinalStage translatedContent(ArticleTranslatedContent translatedContent)

Specified by:

translatedContent in interface ArticleListItem._FinalStage

translatedContent

public ArticleListItem._FinalStage translatedContent(java.util.Optional<ArticleTranslatedContent> translatedContent)

Specified by:

translatedContent in interface ArticleListItem._FinalStage

defaultLocale

public ArticleListItem._FinalStage defaultLocale(java.lang.String defaultLocale)

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

Specified by:

defaultLocale in interface ArticleListItem._FinalStage

Returns:

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

defaultLocale

public ArticleListItem._FinalStage defaultLocale(java.util.Optional<java.lang.String> defaultLocale)

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

Specified by:

defaultLocale in interface ArticleListItem._FinalStage

parentType

public ArticleListItem._FinalStage parentType(java.lang.String parentType)

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

Specified by:

parentType in interface ArticleListItem._FinalStage

Returns:

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

parentType

public ArticleListItem._FinalStage parentType(java.util.Optional<java.lang.String> parentType)

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

Specified by:

parentType in interface ArticleListItem._FinalStage

parentIds

public ArticleListItem._FinalStage parentIds(java.util.List<java.lang.Integer> parentIds)

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

Specified by:

parentIds in interface ArticleListItem._FinalStage

Returns:

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

parentIds

public ArticleListItem._FinalStage parentIds(java.util.Optional<java.util.List<java.lang.Integer>> parentIds)

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

Specified by:

parentIds in interface ArticleListItem._FinalStage

parentId

public ArticleListItem._FinalStage parentId(java.lang.Integer parentId)

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

Specified by:

parentId in interface ArticleListItem._FinalStage

Returns:

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

parentId

public ArticleListItem._FinalStage parentId(java.util.Optional<java.lang.Integer> parentId)

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

Specified by:

parentId in interface ArticleListItem._FinalStage

url

public ArticleListItem._FinalStage url(java.lang.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 ArticleListItem._FinalStage

Returns:

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

url

public ArticleListItem._FinalStage url(java.util.Optional<java.lang.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 ArticleListItem._FinalStage

body

public ArticleListItem._FinalStage body(java.lang.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 ArticleListItem._FinalStage

Returns:

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

body

public ArticleListItem._FinalStage body(java.util.Optional<java.lang.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 ArticleListItem._FinalStage

description

public ArticleListItem._FinalStage description(java.lang.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 ArticleListItem._FinalStage

Returns:

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

description

public ArticleListItem._FinalStage description(java.util.Optional<java.lang.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 ArticleListItem._FinalStage

type

public ArticleListItem._FinalStage type(java.lang.String type)

The type of object - article.

Specified by:

type in interface ArticleListItem._FinalStage

Returns:

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

type

public ArticleListItem._FinalStage type(java.util.Optional<java.lang.String> type)

The type of object - article.

Specified by:

type in interface ArticleListItem._FinalStage

build

public ArticleListItem build()

Specified by:

build in interface ArticleListItem._FinalStage