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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubmitRequest.ComponentIdStageadmin(Admin admin)The Intercom teammate viewing the conversation.SubmitRequestbuild()SubmitRequest.ContextStagecomponentId(java.lang.String componentId)The id of the component clicked by the teammate to trigger the request.SubmitRequest.UserStagecontact(Contact contact)The contact which is currently being viewed by the teammate in the conversation details panel.SubmitRequest.ConversationStagecontext(Context context)The context of where the app is added, where the user last visited, and information on the Messenger settings.SubmitRequest.CurrentCanvasStageconversation(Conversation conversation)The conversation where your app is being shown.SubmitRequest.ContactStagecurrentCanvas(CurrentCanvas currentCanvas)The current canvas the teammate can see.SubmitRequest.Builderfrom(SubmitRequest other)SubmitRequest._FinalStageinputValues(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._FinalStageinputValues(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._FinalStageputAllInputValues(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._FinalStageuser(Contact user)The user who took the action.SubmitRequest.WorkspaceRegionStageworkspaceId(java.lang.String workspaceId)The workspace ID of the teammate.SubmitRequest.AdminStageworkspaceRegion(java.lang.String workspaceRegion)The Intercom hosted region that this app is located in.
-
-
-
Method Detail
-
from
public SubmitRequest.Builder from(SubmitRequest other)
- Specified by:
fromin interfaceSubmitRequest.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_idfor V1.2 and below.- Specified by:
workspaceIdin interfaceSubmitRequest.WorkspaceIdStage- Returns:
- Reference to
thisso 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:
workspaceRegionin interfaceSubmitRequest.WorkspaceRegionStage- Returns:
- Reference to
thisso 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:
adminin interfaceSubmitRequest.AdminStage- Returns:
- Reference to
thisso 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:
componentIdin interfaceSubmitRequest.ComponentIdStage- Returns:
- Reference to
thisso 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:
contextin interfaceSubmitRequest.ContextStage- Returns:
- Reference to
thisso 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:
conversationin interfaceSubmitRequest.ConversationStage- Returns:
- Reference to
thisso 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:
currentCanvasin interfaceSubmitRequest.CurrentCanvasStage- Returns:
- Reference to
thisso 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:
contactin interfaceSubmitRequest.ContactStage- Returns:
- Reference to
thisso 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:
userin interfaceSubmitRequest.UserStage- Returns:
- Reference to
thisso 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:
inputValuesin interfaceSubmitRequest._FinalStage- Returns:
- Reference to
thisso 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:
putAllInputValuesin interfaceSubmitRequest._FinalStage- Returns:
- Reference to
thisso 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:
inputValuesin interfaceSubmitRequest._FinalStage
-
build
public SubmitRequest build()
- Specified by:
buildin interfaceSubmitRequest._FinalStage
-
-