Package com.intercom.api.resources.helpcenter.types

Class Collection.Builder

java.lang.Object

com.intercom.api.resources.helpcenter.types.Collection.Builder

All Implemented Interfaces:

Collection._FinalStage, Collection.CreatedAtStage, Collection.DefaultLocaleStage, Collection.IdStage, Collection.NameStage, Collection.OrderStage, Collection.WorkspaceIdStage

Enclosing class:

Collection

public static final class Collection.Builder
extends java.lang.Object
implements Collection.IdStage, Collection.WorkspaceIdStage, Collection.NameStage, Collection.CreatedAtStage, Collection.OrderStage, Collection.DefaultLocaleStage, Collection._FinalStage

Method Summary

Modifier and Type	Method	Description
Collection	build()
Collection.OrderStage	createdAt(int createdAt)	The time when the article was created (seconds).
Collection._FinalStage	defaultLocale(java.lang.String defaultLocale)	The default locale of the help center.
Collection._FinalStage	description(java.lang.String description)	The description of the collection.
Collection._FinalStage	description(java.util.Optional<java.lang.String> description)
Collection.Builder	from(Collection other)
Collection._FinalStage	helpCenterId(java.lang.Integer helpCenterId)	The id of the help center the collection is in.
Collection._FinalStage	helpCenterId(java.util.Optional<java.lang.Integer> helpCenterId)
Collection._FinalStage	icon(java.lang.String icon)	The icon of the collection.
Collection._FinalStage	icon(java.util.Optional<java.lang.String> icon)
Collection.WorkspaceIdStage	id(java.lang.String id)	The unique identifier for the collection which is given by Intercom.
Collection.CreatedAtStage	name(java.lang.String name)	The name of the collection.
Collection.DefaultLocaleStage	order(int order)	The order of the section in relation to others sections within a collection.
Collection._FinalStage	parentId(java.lang.String parentId)	The id of the parent collection.
Collection._FinalStage	parentId(java.util.Optional<java.lang.String> parentId)
Collection._FinalStage	translatedContent(GroupTranslatedContent translatedContent)
Collection._FinalStage	translatedContent(java.util.Optional<GroupTranslatedContent> translatedContent)
Collection._FinalStage	updatedAt(java.lang.Integer updatedAt)	The time when the article was last updated (seconds).
Collection._FinalStage	updatedAt(java.util.Optional<java.lang.Integer> updatedAt)
Collection._FinalStage	url(java.lang.String url)	The URL of the collection.
Collection._FinalStage	url(java.util.Optional<java.lang.String> url)
Collection.NameStage	workspaceId(java.lang.String workspaceId)	The id of the workspace which the collection belongs to.

Methods inherited from class java.lang.Object

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

Method Detail

from

public Collection.Builder from(Collection other)

Specified by:

from in interface Collection.IdStage

id

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

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

Specified by:

id in interface Collection.IdStage

Returns:

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

workspaceId

public Collection.NameStage workspaceId(@NotNull
                                        java.lang.String workspaceId)

The id of the workspace which the collection belongs to.

Specified by:

workspaceId in interface Collection.WorkspaceIdStage

Returns:

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

name

public Collection.CreatedAtStage name(@NotNull
                                      java.lang.String name)

The name of the collection. For multilingual collections, this will be the name of the default language's content.

Specified by:

name in interface Collection.NameStage

Returns:

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

createdAt

public Collection.OrderStage createdAt(int 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:

createdAt in interface Collection.CreatedAtStage

Returns:

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

order

public Collection.DefaultLocaleStage order(int order)

The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.

Specified by:

order in interface Collection.OrderStage

Returns:

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

defaultLocale

public Collection._FinalStage defaultLocale(@NotNull
                                            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 Collection.DefaultLocaleStage

Returns:

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

helpCenterId

public Collection._FinalStage helpCenterId(java.lang.Integer helpCenterId)

The id of the help center the collection is in.

Specified by:

helpCenterId in interface Collection._FinalStage

Returns:

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

helpCenterId

public Collection._FinalStage helpCenterId(java.util.Optional<java.lang.Integer> helpCenterId)

Specified by:

helpCenterId in interface Collection._FinalStage

parentId

public Collection._FinalStage parentId(java.lang.String parentId)

The id of the parent collection. If null then it is the first level collection.

Specified by:

parentId in interface Collection._FinalStage

Returns:

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

parentId

public Collection._FinalStage parentId(java.util.Optional<java.lang.String> parentId)

Specified by:

parentId in interface Collection._FinalStage

translatedContent

public Collection._FinalStage translatedContent(GroupTranslatedContent translatedContent)

Specified by:

translatedContent in interface Collection._FinalStage

translatedContent

public Collection._FinalStage translatedContent(java.util.Optional<GroupTranslatedContent> translatedContent)

Specified by:

translatedContent in interface Collection._FinalStage

icon

public Collection._FinalStage icon(java.lang.String icon)

The icon of the collection.

Specified by:

icon in interface Collection._FinalStage

Returns:

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

icon

public Collection._FinalStage icon(java.util.Optional<java.lang.String> icon)

Specified by:

icon in interface Collection._FinalStage

url

public Collection._FinalStage url(java.lang.String url)

The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.

Specified by:

url in interface Collection._FinalStage

Returns:

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

url

public Collection._FinalStage url(java.util.Optional<java.lang.String> url)

Specified by:

url in interface Collection._FinalStage

updatedAt

public Collection._FinalStage updatedAt(java.lang.Integer 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:

updatedAt in interface Collection._FinalStage

Returns:

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

updatedAt

public Collection._FinalStage updatedAt(java.util.Optional<java.lang.Integer> updatedAt)

Specified by:

updatedAt in interface Collection._FinalStage

description

public Collection._FinalStage description(java.lang.String description)

The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.

Specified by:

description in interface Collection._FinalStage

Returns:

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

description

public Collection._FinalStage description(java.util.Optional<java.lang.String> description)

Specified by:

description in interface Collection._FinalStage

build

public Collection build()

Specified by:

build in interface Collection._FinalStage