Package com.intercom.api.resources.news.types

Class NewsItem.Builder

java.lang.Object

com.intercom.api.resources.news.types.NewsItem.Builder

All Implemented Interfaces:

NewsItem._FinalStage, NewsItem.BodyStage, NewsItem.CreatedAtStage, NewsItem.IdStage, NewsItem.SenderIdStage, NewsItem.StateStage, NewsItem.TitleStage, NewsItem.WorkspaceIdStage

Enclosing class:

NewsItem

public static final class NewsItem.Builder
extends java.lang.Object
implements NewsItem.IdStage, NewsItem.WorkspaceIdStage, NewsItem.TitleStage, NewsItem.BodyStage, NewsItem.SenderIdStage, NewsItem.StateStage, NewsItem.CreatedAtStage, NewsItem._FinalStage

Method Summary

Modifier and Type	Method	Description
NewsItem.SenderIdStage	body(java.lang.String body)	The news item body, which may contain HTML.
NewsItem	build()
NewsItem._FinalStage	coverImageUrl(java.lang.String coverImageUrl)	URL of the image used as cover.
NewsItem._FinalStage	coverImageUrl(java.util.Optional<java.lang.String> coverImageUrl)	URL of the image used as cover.
NewsItem._FinalStage	createdAt(int createdAt)	Timestamp for when the news item was created.
NewsItem._FinalStage	deliverSilently(java.lang.Boolean deliverSilently)	When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
NewsItem._FinalStage	deliverSilently(java.util.Optional<java.lang.Boolean> deliverSilently)	When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
NewsItem.Builder	from(NewsItem other)
NewsItem.WorkspaceIdStage	id(java.lang.String id)	The unique identifier for the news item which is given by Intercom.
NewsItem._FinalStage	labels(java.util.List<java.util.Optional<java.lang.String>> labels)	Label names displayed to users to categorize the news item.
NewsItem._FinalStage	labels(java.util.Optional<java.util.List<java.util.Optional<java.lang.String>>> labels)	Label names displayed to users to categorize the news item.
NewsItem._FinalStage	newsfeedAssignments(java.util.List<NewsfeedAssignment> newsfeedAssignments)	A list of newsfeed_assignments to assign to the specified newsfeed.
NewsItem._FinalStage	newsfeedAssignments(java.util.Optional<java.util.List<NewsfeedAssignment>> newsfeedAssignments)	A list of newsfeed_assignments to assign to the specified newsfeed.
NewsItem._FinalStage	reactions(java.util.List<java.util.Optional<java.lang.String>> reactions)	Ordered list of emoji reactions to the news item.
NewsItem._FinalStage	reactions(java.util.Optional<java.util.List<java.util.Optional<java.lang.String>>> reactions)	Ordered list of emoji reactions to the news item.
NewsItem.StateStage	senderId(int senderId)	The id of the sender of the news item.
NewsItem.CreatedAtStage	state(NewsItem.State state)	News items will not be visible to your users in the assigned newsfeeds until they are set live.
NewsItem.BodyStage	title(java.lang.String title)	The title of the news item.
NewsItem._FinalStage	updatedAt(java.lang.Integer updatedAt)	Timestamp for when the news item was last updated.
NewsItem._FinalStage	updatedAt(java.util.Optional<java.lang.Integer> updatedAt)	Timestamp for when the news item was last updated.
NewsItem.TitleStage	workspaceId(java.lang.String workspaceId)	The id of the workspace which the news item belongs to.

Methods inherited from class java.lang.Object

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

Method Detail

from

public NewsItem.Builder from(NewsItem other)

Specified by:

from in interface NewsItem.IdStage

id

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

The unique identifier for the news item which is given by Intercom.

The unique identifier for the news item which is given by Intercom.

Specified by:

id in interface NewsItem.IdStage

Returns:

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

workspaceId

public NewsItem.TitleStage workspaceId(@NotNull
                                       java.lang.String workspaceId)

The id of the workspace which the news item belongs to.

The id of the workspace which the news item belongs to.

Specified by:

workspaceId in interface NewsItem.WorkspaceIdStage

Returns:

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

title

public NewsItem.BodyStage title(@NotNull
                                java.lang.String title)

The title of the news item.

The title of the news item.

Specified by:

title in interface NewsItem.TitleStage

Returns:

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

body

public NewsItem.SenderIdStage body(@NotNull
                                   java.lang.String body)

The news item body, which may contain HTML.

The news item body, which may contain HTML.

Specified by:

body in interface NewsItem.BodyStage

Returns:

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

senderId

public NewsItem.StateStage senderId(int senderId)

The id of the sender of the news item. Must be a teammate on the workspace.

The id of the sender of the news item. Must be a teammate on the workspace.

Specified by:

senderId in interface NewsItem.SenderIdStage

Returns:

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

state

public NewsItem.CreatedAtStage state(@NotNull
                                     NewsItem.State state)

News items will not be visible to your users in the assigned newsfeeds until they are set live.

News items will not be visible to your users in the assigned newsfeeds until they are set live.

Specified by:

state in interface NewsItem.StateStage

Returns:

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

createdAt

public NewsItem._FinalStage createdAt(int createdAt)

Timestamp for when the news item was created.

Timestamp for when the news item was created.

Specified by:

createdAt in interface NewsItem.CreatedAtStage

Returns:

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

updatedAt

public NewsItem._FinalStage updatedAt(java.lang.Integer updatedAt)

Timestamp for when the news item was last updated.

Specified by:

updatedAt in interface NewsItem._FinalStage

Returns:

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

updatedAt

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

Timestamp for when the news item was last updated.

Specified by:

updatedAt in interface NewsItem._FinalStage

deliverSilently

public NewsItem._FinalStage deliverSilently(java.lang.Boolean deliverSilently)

When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.

Specified by:

deliverSilently in interface NewsItem._FinalStage

Returns:

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

deliverSilently

public NewsItem._FinalStage deliverSilently(java.util.Optional<java.lang.Boolean> deliverSilently)

When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.

Specified by:

deliverSilently in interface NewsItem._FinalStage

reactions

public NewsItem._FinalStage reactions(java.util.List<java.util.Optional<java.lang.String>> reactions)

Ordered list of emoji reactions to the news item. When empty, reactions are disabled.

Specified by:

reactions in interface NewsItem._FinalStage

Returns:

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

reactions

public NewsItem._FinalStage reactions(java.util.Optional<java.util.List<java.util.Optional<java.lang.String>>> reactions)

Ordered list of emoji reactions to the news item. When empty, reactions are disabled.

Specified by:

reactions in interface NewsItem._FinalStage

coverImageUrl

public NewsItem._FinalStage coverImageUrl(java.lang.String coverImageUrl)

URL of the image used as cover. Must have .jpg or .png extension.

Specified by:

coverImageUrl in interface NewsItem._FinalStage

Returns:

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

coverImageUrl

public NewsItem._FinalStage coverImageUrl(java.util.Optional<java.lang.String> coverImageUrl)

URL of the image used as cover. Must have .jpg or .png extension.

Specified by:

coverImageUrl in interface NewsItem._FinalStage

labels

public NewsItem._FinalStage labels(java.util.List<java.util.Optional<java.lang.String>> labels)

Label names displayed to users to categorize the news item.

Specified by:

labels in interface NewsItem._FinalStage

Returns:

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

labels

public NewsItem._FinalStage labels(java.util.Optional<java.util.List<java.util.Optional<java.lang.String>>> labels)

Label names displayed to users to categorize the news item.

Specified by:

labels in interface NewsItem._FinalStage

newsfeedAssignments

public NewsItem._FinalStage newsfeedAssignments(java.util.List<NewsfeedAssignment> newsfeedAssignments)

A list of newsfeed_assignments to assign to the specified newsfeed.

Specified by:

newsfeedAssignments in interface NewsItem._FinalStage

Returns:

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

newsfeedAssignments

public NewsItem._FinalStage newsfeedAssignments(java.util.Optional<java.util.List<NewsfeedAssignment>> newsfeedAssignments)

A list of newsfeed_assignments to assign to the specified newsfeed.

Specified by:

newsfeedAssignments in interface NewsItem._FinalStage

build

public NewsItem build()

Specified by:

build in interface NewsItem._FinalStage