co.aurasphere.botmill.fb.model.outcoming.factory

Class ListTemplateBuilder

java.lang.Object

co.aurasphere.botmill.fb.bean.FbBotMillBean

co.aurasphere.botmill.fb.model.outcoming.factory.FbBotMillResponseBuilder

co.aurasphere.botmill.fb.model.outcoming.factory.FbBotMillMockableBuilder

co.aurasphere.botmill.fb.model.outcoming.factory.TemplateBaseBuilder

co.aurasphere.botmill.fb.model.outcoming.factory.ListTemplateBuilder

public class ListTemplateBuilder
extends TemplateBaseBuilder

A builder for a List Template.

Author:

Alvin Reyes

See Also:

Facebook's Messenger Platform List Template Documentation

Field Summary

Fields inherited from class co.aurasphere.botmill.fb.model.outcoming.factory.TemplateBaseBuilder

messageBuilder

Method Summary

Methods

Modifier and Type	Method and Description
ListTemplateBuilder	addButton(Button button) Add a Button to this template.
ListTemplateBuilder	addElement(ListTemplateElement element) Adds a ListTemplateElement to this template.
ListTemplateElementBuilder	addElement(String title) Adds a ListTemplateElement to this template.
ListTemplateBuilder	addQuickReply(QuickReply reply) Adds a QuickReply to the current object.
ListTemplateBuilder	addQuickReply(String title, String payload) Adds a QuickReply to the current object.
FbBotMillResponse	build(MessageEnvelope envelope) Builds the FbBotMillResponse that the bot should return.
ListTemplateBuilder	setTopElementStyle(TopElementStyle topElementStyle) Sets/Adds a TopElementStyle to the list template payload.

Methods inherited from class co.aurasphere.botmill.fb.model.outcoming.factory.FbBotMillMockableBuilder

getRecipient

Methods inherited from class co.aurasphere.botmill.fb.bean.FbBotMillBean

eventKind, getLocationMessage, safeGetMessage, safeGetPostbackPayload, safeGetQuickReplyPayload, safeGetRecipient, safeGetRecipientId, safeGetSender, safeGetSenderId, toString, validate

Methods inherited from class java.lang.Object

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

Method Detail

setTopElementStyle

public ListTemplateBuilder setTopElementStyle(TopElementStyle topElementStyle)

Sets/Adds a TopElementStyle to the list template payload.

Parameters:

topElementStyle - the top element style

Returns:

this builder

addElement

public ListTemplateElementBuilder addElement(String title)

Adds a ListTemplateElement to this template.

Parameters:

title - the title of the element to add.

Returns:

a builder for the element.

addElement

public ListTemplateBuilder addElement(ListTemplateElement element)

Adds a ListTemplateElement to this template.

Parameters:

element - the element to add.

Returns:

this builder.

addButton

public ListTemplateBuilder addButton(Button button)

Add a Button to this template.

Parameters:

button - the button to add

Returns:

this builder.

addQuickReply

public ListTemplateBuilder addQuickReply(String title,
                                String payload)

Adds a QuickReply to the current object.

Parameters:

title - the quick reply button label. It can't be empty.

payload - the payload sent back when the button is pressed. It can't be empty.

Returns:

this builder.

See Also:

Facebook's Messenger Platform Quick Replies Documentation

addQuickReply

public ListTemplateBuilder addQuickReply(QuickReply reply)

Adds a QuickReply to the current object.

Parameters:

reply - a quick reply object.

Returns:

this builder.

See Also:

Facebook's Messenger Platform Quick Replies Documentation

build

public FbBotMillResponse build(MessageEnvelope envelope)

Builds the FbBotMillResponse that the bot should return. Creates a response containing a List Template.

Parameters:

envelope - a MessageEnvelope object representing the incoming message.

Returns:

the FbBotMillResponse of this bot.