Package com.intercom.api.types

Class ConfigureRequest.ComponentId.Builder

java.lang.Object

com.intercom.api.types.ConfigureRequest.ComponentId.Builder

All Implemented Interfaces:

ConfigureRequest.ComponentId._FinalStage, ConfigureRequest.ComponentId.AdminStage, ConfigureRequest.ComponentId.ComponentIdStage, ConfigureRequest.ComponentId.ContextStage, ConfigureRequest.ComponentId.CurrentCanvasStage, ConfigureRequest.ComponentId.WorkspaceIdStage, ConfigureRequest.ComponentId.WorkspaceRegionStage

Enclosing class:

ConfigureRequest.ComponentId

public static final class ConfigureRequest.ComponentId.Builder
extends Object
implements ConfigureRequest.ComponentId.WorkspaceIdStage, ConfigureRequest.ComponentId.WorkspaceRegionStage, ConfigureRequest.ComponentId.ComponentIdStage, ConfigureRequest.ComponentId.AdminStage, ConfigureRequest.ComponentId.ContextStage, ConfigureRequest.ComponentId.CurrentCanvasStage, ConfigureRequest.ComponentId._FinalStage

Method Summary

Modifier and Type	Method	Description
ConfigureRequest.ComponentId.ContextStage	admin(Admin admin)	The Intercom teammate configuring the app.
ConfigureRequest.ComponentId	build()
ConfigureRequest.ComponentId.AdminStage	componentId(String componentId)	The id of the component clicked by the teammate to trigger the request.
ConfigureRequest.ComponentId.CurrentCanvasStage	context(Context context)	The context of where the app is added, where the user last visited, and information on the Messenger settings.
ConfigureRequest.ComponentId._FinalStage	currentCanvas(CanvasObject currentCanvas)	The current canvas the teammate can see.
ConfigureRequest.ComponentId.Builder	from(ConfigureRequest.ComponentId other)
ConfigureRequest.ComponentId._FinalStage	inputValues(String key, Object value)	A list of key/value pairs of data, inputted by the teammate on the current canvas.
ConfigureRequest.ComponentId._FinalStage	inputValues(Map<String,Object> inputValues)
ConfigureRequest.ComponentId._FinalStage	putAllInputValues(Map<String,Object> inputValues)	A list of key/value pairs of data, inputted by the teammate on the current canvas.
ConfigureRequest.ComponentId.WorkspaceRegionStage	workspaceId(String workspaceId)	The workspace ID of the teammate.
ConfigureRequest.ComponentId.ComponentIdStage	workspaceRegion(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 Details

from

public ConfigureRequest.ComponentId.Builder from(ConfigureRequest.ComponentId other)

Specified by:

from in interface ConfigureRequest.ComponentId.WorkspaceIdStage

workspaceId

public ConfigureRequest.ComponentId.WorkspaceRegionStage workspaceId(@NotNull
 String workspaceId)

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

Specified by:

workspaceId in interface ConfigureRequest.ComponentId.WorkspaceIdStage

Returns:

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

workspaceRegion

public ConfigureRequest.ComponentId.ComponentIdStage workspaceRegion(@NotNull
 String workspaceRegion)

The Intercom hosted region that this app is located in.

Specified by:

workspaceRegion in interface ConfigureRequest.ComponentId.WorkspaceRegionStage

Returns:

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

componentId

public ConfigureRequest.ComponentId.AdminStage componentId(@NotNull
 String componentId)

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

Specified by:

componentId in interface ConfigureRequest.ComponentId.ComponentIdStage

Returns:

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

admin

public ConfigureRequest.ComponentId.ContextStage admin(@NotNull
 Admin admin)

The Intercom teammate configuring the app.

Specified by:

admin in interface ConfigureRequest.ComponentId.AdminStage

Returns:

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

context

public ConfigureRequest.ComponentId.CurrentCanvasStage context(@NotNull
 Context context)

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

Specified by:

context in interface ConfigureRequest.ComponentId.ContextStage

Returns:

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

currentCanvas

public ConfigureRequest.ComponentId._FinalStage currentCanvas(@NotNull
 CanvasObject currentCanvas)

The current canvas the teammate can see.

Specified by:

currentCanvas in interface ConfigureRequest.ComponentId.CurrentCanvasStage

Returns:

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

inputValues

public ConfigureRequest.ComponentId._FinalStage inputValues(String key,
 Object value)

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

Specified by:

inputValues in interface ConfigureRequest.ComponentId._FinalStage

Returns:

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

putAllInputValues

public ConfigureRequest.ComponentId._FinalStage putAllInputValues(Map<String,Object> inputValues)

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

Specified by:

putAllInputValues in interface ConfigureRequest.ComponentId._FinalStage

Returns:

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

inputValues

public ConfigureRequest.ComponentId._FinalStage inputValues(Map<String,Object> inputValues)

Specified by:

inputValues in interface ConfigureRequest.ComponentId._FinalStage

build

public ConfigureRequest.ComponentId build()

Specified by:

build in interface ConfigureRequest.ComponentId._FinalStage