Class Collection.Builder
- All Implemented Interfaces:
Collection._FinalStage,Collection.CreatedAtStage,Collection.DefaultLocaleStage,Collection.IdStage,Collection.NameStage,Collection.OrderStage,Collection.WorkspaceIdStage
- Enclosing class:
Collection
-
Method Summary
Modifier and TypeMethodDescriptionbuild()createdAt(int createdAt) The time when the article was created (seconds).defaultLocale(String defaultLocale) The default locale of the help center.description(String description) The description of the collection.description(Optional<String> description) from(Collection other) helpCenterId(Integer helpCenterId) The id of the help center the collection is in.helpCenterId(Optional<Integer> helpCenterId) The icon of the collection.The unique identifier for the collection which is given by Intercom.The name of the collection.order(int order) The order of the section in relation to others sections within a collection.The id of the parent collection.translatedContent(GroupTranslatedContent translatedContent) translatedContent(Optional<GroupTranslatedContent> translatedContent) The time when the article was last updated (seconds).The URL of the collection.workspaceId(String workspaceId) The id of the workspace which the collection belongs to.
-
Method Details
-
from
- Specified by:
fromin interfaceCollection.IdStage
-
id
The unique identifier for the collection which is given by Intercom.
- Specified by:
idin interfaceCollection.IdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
workspaceId
The id of the workspace which the collection belongs to.
- Specified by:
workspaceIdin interfaceCollection.WorkspaceIdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
name
The name of the collection. For multilingual collections, this will be the name of the default language's content.
- Specified by:
namein interfaceCollection.NameStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
createdAt
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
- Specified by:
createdAtin interfaceCollection.CreatedAtStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
order
The order of the section in relation to others sections within a collection. Values go from
0upwards.0is the default if there's no order.- Specified by:
orderin interfaceCollection.OrderStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
defaultLocale
The default locale of the help center. This field is only returned for multilingual help centers.
- Specified by:
defaultLocalein interfaceCollection.DefaultLocaleStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
helpCenterId
The id of the help center the collection is in.
- Specified by:
helpCenterIdin interfaceCollection._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
helpCenterId
- Specified by:
helpCenterIdin interfaceCollection._FinalStage
-
parentId
The id of the parent collection. If
nullthen it is the first level collection.- Specified by:
parentIdin interfaceCollection._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
parentId
- Specified by:
parentIdin interfaceCollection._FinalStage
-
translatedContent
- Specified by:
translatedContentin interfaceCollection._FinalStage
-
translatedContent
- Specified by:
translatedContentin interfaceCollection._FinalStage
-
icon
The icon of the collection.
- Specified by:
iconin interfaceCollection._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
icon
- Specified by:
iconin interfaceCollection._FinalStage
-
url
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
- Specified by:
urlin interfaceCollection._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
url
- Specified by:
urlin interfaceCollection._FinalStage
-
updatedAt
The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.
- Specified by:
updatedAtin interfaceCollection._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
updatedAt
- Specified by:
updatedAtin interfaceCollection._FinalStage
-
description
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
- Specified by:
descriptionin interfaceCollection._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
description
- Specified by:
descriptionin interfaceCollection._FinalStage
-
build
- Specified by:
buildin interfaceCollection._FinalStage
-