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

Class TextMessageBuilder

java.lang.Object

co.aurasphere.botmill.fb.bean.FbBotMillBean

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

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

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

public class TextMessageBuilder
extends MessageBaseBuilder

A builder for a message that contains only a plain text message.

Author:

Donato Rimenti

Field Summary

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

quickReplies

Method Summary

Modifier and Type	Method and Description
TextMessageBuilder	addQuickLocationReply(String locationMessage) Adds a Location QuickReply to the current object.
TextMessageBuilder	addQuickReply(QuickReply reply) Adds a QuickReply to the current object.
TextMessageBuilder	addQuickReply(String title, String payload) Adds a QuickReply to the current object.
TextMessageBuilder	addQuickReply(String title, String payload, String imageUrl) 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.FbBotMillResponseBuilder

getRecipient

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

eventKind, getAudioMessage, getFileMessage, getImageMessage, getLocationMessage, getVideoMessage, 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

addQuickReply

public TextMessageBuilder 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 TextMessageBuilder addQuickReply(String title,
                                        String payload,
                                        String imageUrl)

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.

imageUrl - the image to show on the quick reply.

Returns:

this builder.

See Also:

Facebook's Messenger Platform Quick Replies Documentation

addQuickReply

public TextMessageBuilder 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

addQuickLocationReply

public TextMessageBuilder addQuickLocationReply(String locationMessage)

Adds a Location QuickReply to the current object.

Parameters:

locationMessage - the location text

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. Returns a response containing a plain text message.

Parameters:

envelope - a MessageEnvelope object representing the incoming message.

Returns:

the FbBotMillResponse of this bot.

toString

public String toString()

Overrides:

toString in class MessageBaseBuilder