Class CreateArticleRequest.Builder
- All Implemented Interfaces:
CreateArticleRequest._FinalStage,CreateArticleRequest.AuthorIdStage,CreateArticleRequest.TitleStage
- Enclosing class:
CreateArticleRequest
-
Method Summary
Modifier and TypeMethodDescriptionauthorId(int authorId) The id of the author of the article.The content of the article.build()description(String description) The description of the article.description(Optional<String> description) from(CreateArticleRequest other) The id of the article's parent collection or section.parentType(CreateArticleRequest.ParentType parentType) The type of parent, which can either be acollectionorsection.parentType(Optional<CreateArticleRequest.ParentType> parentType) state(CreateArticleRequest.State state) Whether the article will bepublishedor will be adraft.state(Optional<CreateArticleRequest.State> state) The title of the article.For multilingual articles, this will be the title of the default language's content.translatedContent(ArticleTranslatedContent translatedContent) translatedContent(Optional<ArticleTranslatedContent> translatedContent)
-
Method Details
-
from
- Specified by:
fromin interfaceCreateArticleRequest.TitleStage
-
title
The title of the article.For multilingual articles, this will be the title of the default language's content.
- Specified by:
titlein interfaceCreateArticleRequest.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 interfaceCreateArticleRequest.AuthorIdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
translatedContent
public CreateArticleRequest._FinalStage translatedContent(ArticleTranslatedContent translatedContent) - Specified by:
translatedContentin interfaceCreateArticleRequest._FinalStage
-
translatedContent
public CreateArticleRequest._FinalStage translatedContent(Optional<ArticleTranslatedContent> translatedContent) - Specified by:
translatedContentin interfaceCreateArticleRequest._FinalStage
-
parentType
The type of parent, which can either be a
collectionorsection.- Specified by:
parentTypein interfaceCreateArticleRequest._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
parentType
public CreateArticleRequest._FinalStage parentType(Optional<CreateArticleRequest.ParentType> parentType) - Specified by:
parentTypein interfaceCreateArticleRequest._FinalStage
-
parentId
The id of the article's parent collection or section. An article without this field stands alone.
- Specified by:
parentIdin interfaceCreateArticleRequest._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
parentId
- Specified by:
parentIdin interfaceCreateArticleRequest._FinalStage
-
state
Whether the article will be
publishedor will be adraft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.- Specified by:
statein interfaceCreateArticleRequest._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
state
- Specified by:
statein interfaceCreateArticleRequest._FinalStage
-
body
The content of the article. For multilingual articles, this will be the body of the default language's content.
- Specified by:
bodyin interfaceCreateArticleRequest._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
body
- Specified by:
bodyin interfaceCreateArticleRequest._FinalStage
-
description
The description of the article. For multilingual articles, this will be the description of the default language's content.
- Specified by:
descriptionin interfaceCreateArticleRequest._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
description
- Specified by:
descriptionin interfaceCreateArticleRequest._FinalStage
-
build
- Specified by:
buildin interfaceCreateArticleRequest._FinalStage
-