Package com.intercom.api.types

Class CreateArticleRequest.Builder

java.lang.Object

com.intercom.api.types.CreateArticleRequest.Builder

All Implemented Interfaces:

CreateArticleRequest._FinalStage, CreateArticleRequest.AuthorIdStage, CreateArticleRequest.TitleStage

Enclosing class:

CreateArticleRequest

public static final class CreateArticleRequest.Builder
extends java.lang.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(java.lang.String body)	The content of the article.
CreateArticleRequest._FinalStage	body(java.util.Optional<java.lang.String> body)	The content of the article.
CreateArticleRequest	build()
CreateArticleRequest._FinalStage	description(java.lang.String description)	The description of the article.
CreateArticleRequest._FinalStage	description(java.util.Optional<java.lang.String> description)	The description of the article.
CreateArticleRequest.Builder	from(CreateArticleRequest other)
CreateArticleRequest._FinalStage	parentId(java.lang.Integer parentId)	The id of the article's parent collection or section.
CreateArticleRequest._FinalStage	parentId(java.util.Optional<java.lang.Integer> parentId)	The id of the article's parent collection or section.
CreateArticleRequest._FinalStage	parentType(CreateArticleRequest.ParentType parentType)	The type of parent, which can either be a collection or section.
CreateArticleRequest._FinalStage	parentType(java.util.Optional<CreateArticleRequest.ParentType> parentType)	The type of parent, which can either be a collection or section.
CreateArticleRequest._FinalStage	state(CreateArticleRequest.State state)	Whether the article will be published or will be a draft.
CreateArticleRequest._FinalStage	state(java.util.Optional<CreateArticleRequest.State> state)	Whether the article will be published or will be a draft.
CreateArticleRequest.AuthorIdStage	title(java.lang.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(java.util.Optional<ArticleTranslatedContent> translatedContent)

Methods inherited from class java.lang.Object

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

Method Detail

from

public CreateArticleRequest.Builder from(CreateArticleRequest other)

Specified by:

from in interface CreateArticleRequest.TitleStage

title

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

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(java.util.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(java.util.Optional<CreateArticleRequest.ParentType> parentType)

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

Specified by:

parentType in interface CreateArticleRequest._FinalStage

parentId

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

Returns:

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

parentId

public CreateArticleRequest._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 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(java.util.Optional<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

body

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

description

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

Returns:

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

description

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

build

public CreateArticleRequest build()

Specified by:

build in interface CreateArticleRequest._FinalStage