Package com.intercom.api.types

Class CanvasObject.Builder

java.lang.Object

com.intercom.api.types.CanvasObject.Builder

All Implemented Interfaces:

CanvasObject._FinalStage, CanvasObject.ContentStage

Enclosing class:

CanvasObject

public static final class CanvasObject.Builder
extends java.lang.Object
implements CanvasObject.ContentStage, CanvasObject._FinalStage

Method Summary

Modifier and Type	Method	Description
CanvasObject	build()
CanvasObject._FinalStage	content(ContentObject content)	The content object that will be shown as the UI of the app.
CanvasObject._FinalStage	contentUrl(java.lang.String contentUrl)	The URL which we make Live Canvas requests to.
CanvasObject._FinalStage	contentUrl(java.util.Optional<java.lang.String> contentUrl)	The URL which we make Live Canvas requests to.
CanvasObject.Builder	from(CanvasObject other)
CanvasObject._FinalStage	storedData(java.util.Map<java.lang.String,java.lang.Object> storedData)	Optional Stored Data that you want to be returned in the next sent request.
CanvasObject._FinalStage	storedData(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> storedData)	Optional Stored Data that you want to be returned in the next sent request.

Methods inherited from class java.lang.Object

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

Method Detail

from

public CanvasObject.Builder from(CanvasObject other)

Specified by:

from in interface CanvasObject.ContentStage

content

public CanvasObject._FinalStage content(@NotNull
                                        ContentObject content)

The content object that will be shown as the UI of the app. Max Size is 64KB.

The content object that will be shown as the UI of the app. Max Size is 64KB.

Specified by:

content in interface CanvasObject.ContentStage

Returns:

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

storedData

public CanvasObject._FinalStage storedData(java.util.Map<java.lang.String,java.lang.Object> storedData)

Optional Stored Data that you want to be returned in the next sent request. Max Size is 64KB.

Specified by:

storedData in interface CanvasObject._FinalStage

Returns:

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

storedData

public CanvasObject._FinalStage storedData(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> storedData)

Optional Stored Data that you want to be returned in the next sent request. Max Size is 64KB.

Specified by:

storedData in interface CanvasObject._FinalStage

contentUrl

public CanvasObject._FinalStage contentUrl(java.lang.String contentUrl)

The URL which we make Live Canvas requests to. You must respond to these with a content object. Max size is 64KB.

Specified by:

contentUrl in interface CanvasObject._FinalStage

Returns:

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

contentUrl

public CanvasObject._FinalStage contentUrl(java.util.Optional<java.lang.String> contentUrl)

The URL which we make Live Canvas requests to. You must respond to these with a content object. Max size is 64KB.

Specified by:

contentUrl in interface CanvasObject._FinalStage

build

public CanvasObject build()

Specified by:

build in interface CanvasObject._FinalStage