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

Class ButtonTemplateBuilder

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

public class ButtonTemplateBuilder
extends TemplateBaseBuilder

A builder for a Button Template.

Author:

Donato Rimenti

See Also:

Facebook's Messenger Platform Button 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
ButtonTemplateBuilder	addButton(Button button) Adds a button to the current template.
ButtonTemplateBuilder	addPhoneNumberButton(String title, String phoneNumber) Adds a button with a phone number to the current template.
ButtonTemplateBuilder	addPostbackButton(String title, String payload) Adds a button which sends a payload back when clicked to the current template.
ButtonTemplateBuilder	addUrlButton(String title, String url) Adds a button which redirects to an URL when clicked to the current template.
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

addUrlButton

public ButtonTemplateBuilder addUrlButton(String title,
                                 String url)

Adds a button which redirects to an URL when clicked to the current template. There can be at most 3 buttons.

Parameters:

title - the button label.

url - the URL to whom redirect when clicked.

Returns:

this builder.

addPhoneNumberButton

public ButtonTemplateBuilder addPhoneNumberButton(String title,
                                         String phoneNumber)

Adds a button with a phone number to the current template. There can be at most 3 buttons.

Parameters:

title - the button label.

phoneNumber - a phone number.

Returns:

this builder.

addPostbackButton

public ButtonTemplateBuilder addPostbackButton(String title,
                                      String payload)

Adds a button which sends a payload back when clicked to the current template. There can be at most 3 buttons.

Parameters:

title - the button label.

payload - the payload to send back when clicked.

Returns:

this builder.

addButton

public ButtonTemplateBuilder addButton(Button button)

Adds a button to the current template. There can be at most 3 buttons per element.

Parameters:

button - the button to add.

Returns:

this builder.

build

public FbBotMillResponse build(MessageEnvelope envelope)

Builds the FbBotMillResponse that the bot should return. Creates a response that contains a Button 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