Package com.intercom.api.types

Class LiveCanvasRequest.Builder

java.lang.Object

com.intercom.api.types.LiveCanvasRequest.Builder

All Implemented Interfaces:

LiveCanvasRequest._FinalStage, LiveCanvasRequest.CanvasStage, LiveCanvasRequest.ContactStage, LiveCanvasRequest.ContextStage, LiveCanvasRequest.WorkspaceIdStage, LiveCanvasRequest.WorkspaceRegionStage

Enclosing class:

LiveCanvasRequest

public static final class LiveCanvasRequest.Builder
extends java.lang.Object
implements LiveCanvasRequest.WorkspaceIdStage, LiveCanvasRequest.WorkspaceRegionStage, LiveCanvasRequest.CanvasStage, LiveCanvasRequest.ContextStage, LiveCanvasRequest.ContactStage, LiveCanvasRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
LiveCanvasRequest	build()
LiveCanvasRequest.ContextStage	canvas(CanvasObject canvas)	The current_canvas the teammate can see.
LiveCanvasRequest._FinalStage	contact(Contact contact)	The contact who viewed the card.
LiveCanvasRequest.ContactStage	context(Context context)	The context of where the app is added, where the user last visited, and information on the Messenger settings.
LiveCanvasRequest.Builder	from(LiveCanvasRequest other)
LiveCanvasRequest.WorkspaceRegionStage	workspaceId(java.lang.String workspaceId)	The workspace ID of the teammate.
LiveCanvasRequest.CanvasStage	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 LiveCanvasRequest.Builder from(LiveCanvasRequest other)

Specified by:

from in interface LiveCanvasRequest.WorkspaceIdStage

workspaceId

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

Returns:

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

workspaceRegion

public LiveCanvasRequest.CanvasStage 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 LiveCanvasRequest.WorkspaceRegionStage

Returns:

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

canvas

public LiveCanvasRequest.ContextStage canvas(@NotNull
                                             CanvasObject canvas)

The current_canvas the teammate can see.

The current_canvas the teammate can see.

Specified by:

canvas in interface LiveCanvasRequest.CanvasStage

Returns:

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

context

public LiveCanvasRequest.ContactStage 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 LiveCanvasRequest.ContextStage

Returns:

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

contact

public LiveCanvasRequest._FinalStage contact(@NotNull
                                             Contact contact)

The contact who viewed the card.

The contact who viewed the card.

Specified by:

contact in interface LiveCanvasRequest.ContactStage

Returns:

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

build

public LiveCanvasRequest build()

Specified by:

build in interface LiveCanvasRequest._FinalStage