Package com.intercom.api.resources.articles.requests

Class CreateArticleRequest.Builder

java.lang.Object

com.intercom.api.resources.articles.requests.CreateArticleRequest.Builder

All Implemented Interfaces:

CreateArticleRequest._FinalStage, CreateArticleRequest.AuthorIdStage, CreateArticleRequest.TitleStage

Enclosing class:

CreateArticleRequest

public static final class CreateArticleRequest.Builder
extends Object
implements CreateArticleRequest.TitleStage, CreateArticleRequest.AuthorIdStage, CreateArticleRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
CreateArticleRequest._FinalStage	authorId(int authorId)	The id of the author of the article.
CreateArticleRequest._FinalStage	body(String body)	The content of the article.
CreateArticleRequest._FinalStage	body(Optional<String> body)
CreateArticleRequest	build()
CreateArticleRequest._FinalStage	description(String description)	The description of the article.
CreateArticleRequest._FinalStage	description(Optional<String> description)
CreateArticleRequest.Builder	from(CreateArticleRequest other)
CreateArticleRequest._FinalStage	parentId(Integer parentId)	The id of the article's parent collection or section.
CreateArticleRequest._FinalStage	parentId(Optional<Integer> parentId)
CreateArticleRequest._FinalStage	parentType(CreateArticleRequest.ParentType parentType)	The type of parent, which can either be a collection or section.
CreateArticleRequest._FinalStage	parentType(Optional<CreateArticleRequest.ParentType> parentType)
CreateArticleRequest._FinalStage	state(CreateArticleRequest.State state)	Whether the article will be published or will be a draft.
CreateArticleRequest._FinalStage	state(Optional<CreateArticleRequest.State> state)
CreateArticleRequest.AuthorIdStage	title(String title)	The title of the article.For multilingual articles, this will be the title of the default language's content.
CreateArticleRequest._FinalStage	translatedContent(ArticleTranslatedContent translatedContent)
CreateArticleRequest._FinalStage	translatedContent(Optional<ArticleTranslatedContent> translatedContent)

Methods inherited from class java.lang.Object

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

Method Details

from

public CreateArticleRequest.Builder from(CreateArticleRequest other)

Specified by:

from in interface CreateArticleRequest.TitleStage

title

public CreateArticleRequest.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 CreateArticleRequest.TitleStage

Returns:

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

authorId

public CreateArticleRequest._FinalStage 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 CreateArticleRequest.AuthorIdStage

Returns:

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

translatedContent

public CreateArticleRequest._FinalStage translatedContent(ArticleTranslatedContent translatedContent)

Specified by:

translatedContent in interface CreateArticleRequest._FinalStage

translatedContent

public CreateArticleRequest._FinalStage translatedContent(Optional<ArticleTranslatedContent> translatedContent)

Specified by:

translatedContent in interface CreateArticleRequest._FinalStage

parentType

public CreateArticleRequest._FinalStage parentType(CreateArticleRequest.ParentType parentType)

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

Specified by:

parentType in interface CreateArticleRequest._FinalStage

Returns:

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

parentType

public CreateArticleRequest._FinalStage parentType(Optional<CreateArticleRequest.ParentType> parentType)

Specified by:

parentType in interface CreateArticleRequest._FinalStage

parentId

public CreateArticleRequest._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 CreateArticleRequest._FinalStage

Returns:

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

parentId

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

Specified by:

parentId in interface CreateArticleRequest._FinalStage

state

public CreateArticleRequest._FinalStage state(CreateArticleRequest.State state)

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

Specified by:

state in interface CreateArticleRequest._FinalStage

Returns:

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

state

public CreateArticleRequest._FinalStage state(Optional<CreateArticleRequest.State> state)

Specified by:

state in interface CreateArticleRequest._FinalStage

body

public CreateArticleRequest._FinalStage body(String body)

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

Specified by:

body in interface CreateArticleRequest._FinalStage

Returns:

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

body

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

Specified by:

body in interface CreateArticleRequest._FinalStage

description

public CreateArticleRequest._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 CreateArticleRequest._FinalStage

Returns:

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

description

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

Specified by:

description in interface CreateArticleRequest._FinalStage

build

public CreateArticleRequest build()

Specified by:

build in interface CreateArticleRequest._FinalStage