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

Class AirlineCheckinTemplateBuilder

java.lang.Object

co.aurasphere.botmill.fb.bean.FbBotMillBean

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

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

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

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

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

public class AirlineCheckinTemplateBuilder
extends FlightInfoBuilderDelegator

A builder for an Airline Checkin Template.

Author:

Donato Rimenti

See Also:

Facebook's Messenger Platform Airline Checkin Template Documentation

Field Summary

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

messageBuilder

Method Summary

Modifier and Type	Method and Description
FlightInfoBuilder<AirlineCheckinTemplateBuilder>	addFlightInfo(String flightNumber) Adds a FlightInfo object to this template.
AirlineCheckinTemplateBuilder	addQuickReply(QuickReply reply) Adds a QuickReply to the current object.
AirlineCheckinTemplateBuilder	addQuickReply(String title, String payload) Adds a QuickReply to the current object.
FbBotMillResponse	build(MessageEnvelope envelope) Builds the FbBotMillResponse that the bot should return.
AirlineCheckinTemplateBuilder	setThemeColor(String themeColor) Sets the theme color for this template.
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

addFlightInfo

public FlightInfoBuilder<AirlineCheckinTemplateBuilder> addFlightInfo(String flightNumber)

Adds a FlightInfo object to this template. This object is mandatory and can't be null for Airline templates. There can be multiple flight info object but there must be at least one.

Parameters:

flightNumber - the flight number. It can't be empty.

Returns:

a builder for the FlightInfo object.

setThemeColor

public AirlineCheckinTemplateBuilder setThemeColor(String themeColor)

Sets the theme color for this template. This field is optional. If not specified, the template will use Facebook's default theme (light blue).

Parameters:

themeColor - the color for this template. The Color must be a valid RGB color in the format #RRGGBB.

Returns:

this builder.

addQuickReply

public AirlineCheckinTemplateBuilder 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 AirlineCheckinTemplateBuilder 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. The template builders, like this, delegate an AttachmentMessageBuilder to build the message.

Parameters:

envelope - a MessageEnvelope object representing the incoming message.

Returns:

the FbBotMillResponse of this bot.

toString

public String toString()

Overrides:

toString in class FlightInfoBuilderDelegator