Package com.intercom.api.types

Class InitializeRequest.Builder

java.lang.Object

com.intercom.api.types.InitializeRequest.Builder

All Implemented Interfaces:

InitializeRequest._FinalStage, InitializeRequest.AdminStage, InitializeRequest.ContactStage, InitializeRequest.ContextStage, InitializeRequest.ConversationStage, InitializeRequest.WorkspaceIdStage, InitializeRequest.WorkspaceRegionStage

Enclosing class:

InitializeRequest

public static final class InitializeRequest.Builder
extends java.lang.Object
implements InitializeRequest.WorkspaceIdStage, InitializeRequest.WorkspaceRegionStage, InitializeRequest.AdminStage, InitializeRequest.ContextStage, InitializeRequest.ConversationStage, InitializeRequest.ContactStage, InitializeRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
InitializeRequest.ContextStage	admin(Admin admin)	The Intercom teammate viewing the conversation.
InitializeRequest	build()
InitializeRequest._FinalStage	cardCreationOptions(java.lang.String key, java.lang.Object value)	Key-value pairs which were given as results in response to the Configure request.
InitializeRequest._FinalStage	cardCreationOptions(java.util.Map<java.lang.String,java.lang.Object> cardCreationOptions)	Key-value pairs which were given as results in response to the Configure request.
InitializeRequest._FinalStage	contact(Contact contact)	The contact which is currently being viewed by the teammate in the conversation details panel.
InitializeRequest.ConversationStage	context(Context context)	The context of where the app is added, where the user last visited, and information on the Messenger settings.
InitializeRequest.ContactStage	conversation(Conversation conversation)	The conversation your app is being shown for.
InitializeRequest.Builder	from(InitializeRequest other)
InitializeRequest._FinalStage	putAllCardCreationOptions(java.util.Map<java.lang.String,java.lang.Object> cardCreationOptions)	Key-value pairs which were given as results in response to the Configure request.
InitializeRequest.WorkspaceRegionStage	workspaceId(java.lang.String workspaceId)	The workspace ID of the teammate.
InitializeRequest.AdminStage	workspaceRegion(java.lang.String workspaceRegion)	The Intercom hosted region that this app is located in.

Methods inherited from class java.lang.Object

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

Method Detail

from

public InitializeRequest.Builder from(InitializeRequest other)

Specified by:

from in interface InitializeRequest.WorkspaceIdStage

workspaceId

public InitializeRequest.WorkspaceRegionStage workspaceId(@NotNull
                                                          java.lang.String workspaceId)

The workspace ID of the teammate. Attribute is `app_id` for V1.2 and below.

The workspace ID of the teammate. Attribute is app_id for V1.2 and below.

Specified by:

workspaceId in interface InitializeRequest.WorkspaceIdStage

Returns:

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

workspaceRegion

public InitializeRequest.AdminStage workspaceRegion(@NotNull
                                                    java.lang.String workspaceRegion)

The Intercom hosted region that this app is located in.

The Intercom hosted region that this app is located in.

Specified by:

workspaceRegion in interface InitializeRequest.WorkspaceRegionStage

Returns:

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

admin

public InitializeRequest.ContextStage admin(@NotNull
                                            Admin admin)

The Intercom teammate viewing the conversation.

The Intercom teammate viewing the conversation.

Specified by:

admin in interface InitializeRequest.AdminStage

Returns:

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

context

public InitializeRequest.ConversationStage context(@NotNull
                                                   Context context)

The context of where the app is added, where the user last visited, and information on the Messenger settings.

The context of where the app is added, where the user last visited, and information on the Messenger settings.

Specified by:

context in interface InitializeRequest.ContextStage

Returns:

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

conversation

public InitializeRequest.ContactStage conversation(@NotNull
                                                   Conversation conversation)

The conversation your app is being shown for.

The conversation your app is being shown for.

Specified by:

conversation in interface InitializeRequest.ConversationStage

Returns:

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

contact

public InitializeRequest._FinalStage contact(@NotNull
                                             Contact contact)

The contact which is currently being viewed by the teammate in the conversation details panel. We send an individual initialize request for each customer when it's a group conversation.

The contact which is currently being viewed by the teammate in the conversation details panel. We send an individual initialize request for each customer when it's a group conversation.

Specified by:

contact in interface InitializeRequest.ContactStage

Returns:

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

cardCreationOptions

public InitializeRequest._FinalStage cardCreationOptions(java.lang.String key,
                                                         java.lang.Object value)

Key-value pairs which were given as results in response to the Configure request.

Specified by:

cardCreationOptions in interface InitializeRequest._FinalStage

Returns:

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

putAllCardCreationOptions

public InitializeRequest._FinalStage putAllCardCreationOptions(java.util.Map<java.lang.String,java.lang.Object> cardCreationOptions)

Key-value pairs which were given as results in response to the Configure request.

Specified by:

putAllCardCreationOptions in interface InitializeRequest._FinalStage

Returns:

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

cardCreationOptions

public InitializeRequest._FinalStage cardCreationOptions(java.util.Map<java.lang.String,java.lang.Object> cardCreationOptions)

Key-value pairs which were given as results in response to the Configure request.

Specified by:

cardCreationOptions in interface InitializeRequest._FinalStage

build

public InitializeRequest build()

Specified by:

build in interface InitializeRequest._FinalStage