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

Class GenericTemplateBuilder

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.GenericTemplateBuilder

public class GenericTemplateBuilder
extends TemplateBaseBuilder

A builder for a Generic Template.

Author:

Donato Rimenti

See Also:

Facebook's Messenger Platform Generic 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
GenericTemplateBuilder	addElement(GenericTemplateElement element) Adds a GenericTemplateElement to this template.
GenericTemplateElementBuilder	addElement(String title) Adds a GenericTemplateElement to this template.
GenericTemplateBuilder	addQuickReply(QuickReply reply) Adds a QuickReply to the current object.
GenericTemplateBuilder	addQuickReply(String title, String payload) Adds a QuickReply to the current object.
FbBotMillResponse	build(MessageEnvelope envelope) Builds the FbBotMillResponse that the bot should return.
String	toString()

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, validate

Methods inherited from class java.lang.Object

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

Method Detail

addElement

public GenericTemplateElementBuilder addElement(String title)

Adds a GenericTemplateElement to this template.

Parameters:

title - the title of the element to add.

Returns:

a builder for the element.

addElement

public GenericTemplateBuilder addElement(GenericTemplateElement element)

Adds a GenericTemplateElement to this template.

Parameters:

element - the element to add.

Returns:

this builder.

addQuickReply

public GenericTemplateBuilder 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 GenericTemplateBuilder 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 Generic Template.

Parameters:

envelope - a MessageEnvelope object representing the incoming message.

Returns:

the FbBotMillResponse of this bot.

toString

public String toString()

Overrides:

toString in class TemplateBaseBuilder