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

Class AirlineBoardingPassTemplateBuilder

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

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

public class AirlineBoardingPassTemplateBuilder
extends AirlineBaseTemplateBuilder

A builder for an Airline Boarding Pass Template.

Author:

Donato Rimenti

See Also:

Facebook's Messenger Platform Airline Boarding Pass 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
AirlineBoardingPassTemplateBuilder	addBoardingPass(BoardingPass boardingPass) Adds a BoardingPass object to this template.
BoardingPassBuilder	addBoardingPass(String passengerName, String pnrNumber, String logoImageUrl, String aboveBarCodeImageUrl) Adds a BoardingPass object to this template.
AirlineBoardingPassTemplateBuilder	addQuickReply(QuickReply reply) Adds a QuickReply to the current object.
AirlineBoardingPassTemplateBuilder	addQuickReply(String title, String payload) Adds a QuickReply to the current object.
FbBotMillResponse	build(MessageEnvelope envelope) Builds the FbBotMillResponse that the bot should return.
AirlineBoardingPassTemplateBuilder	setThemeColor(String themeColor) Sets the theme color for this template.

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

addBoardingPass

public BoardingPassBuilder addBoardingPass(String passengerName,
                                  String pnrNumber,
                                  String logoImageUrl,
                                  String aboveBarCodeImageUrl)

Adds a BoardingPass object to this template. This field is mandatory for this template and should contain at least one element.

Parameters:

passengerName - the passenger name. It can't be empty.

pnrNumber - the Passenger Name Record number (Booking Number). It can't be empty.

logoImageUrl - the URL of the logo. It can't be empty.

aboveBarCodeImageUrl - the URL of the image to be shown above the bar code in the center of the pass. It can't be empty.

Returns:

a builder for a BoardingPass object.

addBoardingPass

public AirlineBoardingPassTemplateBuilder addBoardingPass(BoardingPass boardingPass)

Adds a BoardingPass object to this template. This field is mandatory for this template and should contain at least one element.

Parameters:

boardingPass - the boarding pass object to add. It can't be null.

Returns:

this builder.

setThemeColor

public AirlineBoardingPassTemplateBuilder 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 AirlineBoardingPassTemplateBuilder 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 AirlineBoardingPassTemplateBuilder 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.