Package com.intercom.api.types

Class SubmitRequest.Builder

java.lang.Object

com.intercom.api.types.SubmitRequest.Builder

All Implemented Interfaces:

SubmitRequest._FinalStage, SubmitRequest.AdminStage, SubmitRequest.ComponentIdStage, SubmitRequest.ContactStage, SubmitRequest.ContextStage, SubmitRequest.ConversationStage, SubmitRequest.CurrentCanvasStage, SubmitRequest.UserStage, SubmitRequest.WorkspaceIdStage, SubmitRequest.WorkspaceRegionStage

Enclosing class:

SubmitRequest

public static final class SubmitRequest.Builder
extends java.lang.Object
implements SubmitRequest.WorkspaceIdStage, SubmitRequest.WorkspaceRegionStage, SubmitRequest.AdminStage, SubmitRequest.ComponentIdStage, SubmitRequest.ContextStage, SubmitRequest.ConversationStage, SubmitRequest.CurrentCanvasStage, SubmitRequest.ContactStage, SubmitRequest.UserStage, SubmitRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
SubmitRequest.ComponentIdStage	admin(Admin admin)	The Intercom teammate viewing the conversation.
SubmitRequest	build()
SubmitRequest.ContextStage	componentId(java.lang.String componentId)	The id of the component clicked by the teammate to trigger the request.
SubmitRequest.UserStage	contact(Contact contact)	The contact which is currently being viewed by the teammate in the conversation details panel.
SubmitRequest.ConversationStage	context(Context context)	The context of where the app is added, where the user last visited, and information on the Messenger settings.
SubmitRequest.CurrentCanvasStage	conversation(Conversation conversation)	The conversation where your app is being shown.
SubmitRequest.ContactStage	currentCanvas(CurrentCanvas currentCanvas)	The current canvas the teammate can see.
SubmitRequest.Builder	from(SubmitRequest other)
SubmitRequest._FinalStage	inputValues(java.lang.String key, java.lang.Object value)	A list of key/value pairs of data, inputted by the teammate on the current canvas.
SubmitRequest._FinalStage	inputValues(java.util.Map<java.lang.String,java.lang.Object> inputValues)	A list of key/value pairs of data, inputted by the teammate on the current canvas.
SubmitRequest._FinalStage	putAllInputValues(java.util.Map<java.lang.String,java.lang.Object> inputValues)	A list of key/value pairs of data, inputted by the teammate on the current canvas.
SubmitRequest._FinalStage	user(Contact user)	The user who took the action.
SubmitRequest.WorkspaceRegionStage	workspaceId(java.lang.String workspaceId)	The workspace ID of the teammate.
SubmitRequest.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 SubmitRequest.Builder from(SubmitRequest other)

Specified by:

from in interface SubmitRequest.WorkspaceIdStage

workspaceId

public SubmitRequest.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 SubmitRequest.WorkspaceIdStage

Returns:

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

workspaceRegion

public SubmitRequest.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 SubmitRequest.WorkspaceRegionStage

Returns:

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

admin

public SubmitRequest.ComponentIdStage admin(@NotNull
                                            Admin admin)

The Intercom teammate viewing the conversation.

The Intercom teammate viewing the conversation.

Specified by:

admin in interface SubmitRequest.AdminStage

Returns:

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

componentId

public SubmitRequest.ContextStage componentId(@NotNull
                                              java.lang.String componentId)

The id of the component clicked by the teammate to trigger the request.

The id of the component clicked by the teammate to trigger the request.

Specified by:

componentId in interface SubmitRequest.ComponentIdStage

Returns:

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

context

public SubmitRequest.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 SubmitRequest.ContextStage

Returns:

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

conversation

public SubmitRequest.CurrentCanvasStage conversation(@NotNull
                                                     Conversation conversation)

The conversation where your app is being shown.

The conversation where your app is being shown.

Specified by:

conversation in interface SubmitRequest.ConversationStage

Returns:

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

currentCanvas

public SubmitRequest.ContactStage currentCanvas(@NotNull
                                                CurrentCanvas currentCanvas)

The current canvas the teammate can see.

The current canvas the teammate can see.

Specified by:

currentCanvas in interface SubmitRequest.CurrentCanvasStage

Returns:

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

contact

public SubmitRequest.UserStage contact(@NotNull
                                       Contact contact)

The contact which is currently being viewed by the teammate in the conversation details panel.

The contact which is currently being viewed by the teammate in the conversation details panel.

Specified by:

contact in interface SubmitRequest.ContactStage

Returns:

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

user

public SubmitRequest._FinalStage user(@NotNull
                                      Contact user)

The user who took the action.

The user who took the action.

Specified by:

user in interface SubmitRequest.UserStage

Returns:

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

inputValues

public SubmitRequest._FinalStage inputValues(java.lang.String key,
                                             java.lang.Object value)

A list of key/value pairs of data, inputted by the teammate on the current canvas.

Specified by:

inputValues in interface SubmitRequest._FinalStage

Returns:

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

putAllInputValues

public SubmitRequest._FinalStage putAllInputValues(java.util.Map<java.lang.String,java.lang.Object> inputValues)

A list of key/value pairs of data, inputted by the teammate on the current canvas.

Specified by:

putAllInputValues in interface SubmitRequest._FinalStage

Returns:

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

inputValues

public SubmitRequest._FinalStage inputValues(java.util.Map<java.lang.String,java.lang.Object> inputValues)

A list of key/value pairs of data, inputted by the teammate on the current canvas.

Specified by:

inputValues in interface SubmitRequest._FinalStage

build

public SubmitRequest build()

Specified by:

build in interface SubmitRequest._FinalStage