AirlineItineraryTemplateBuilder (FB-BotMill 2.0.0-RC2 API)

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

```
public class AirlineItineraryTemplateBuilder
extends FlightInfoBuilderDelegator
```
Builder for an Airline Itinerary Template.

Author:

Donato Rimenti

See Also:

Facebook's Messenger Platform Airline Itinerary Template Documentation

Field Summary
- Fields inherited from class co.aurasphere.botmill.fb.model.outcoming.factory.TemplateBaseBuilder
  messageBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AirlineItineraryTemplateBuilder`	`addFlightInfo(FlightInfoExtended flightInfo)` Adds a `FlightInfoExtended` object to this template.
`FlightInfoExtendedBuilder`	`addFlightInfo(String flightNumber, String connectionId, String segmentId, TravelClass travelClass)` Adds a `FlightInfoExtended` object to this template.
`AirlineItineraryTemplateBuilder`	`addPassengerInfo(PassengerInfo passengerInfo)` Adds a `PassengerInfo` object to this template.
`AirlineItineraryTemplateBuilder`	`addPassengerInfo(String passengerId, String name)` Adds a `PassengerInfo` object to this template.
`AirlineItineraryTemplateBuilder`	`addPassengerInfo(String passengerId, String name, String ticketNumber)` Adds a `PassengerInfo` object to this template.
`AirlineItineraryTemplateBuilder`	`addPassengerSegmentInfo(PassengerSegmentInfo segmentInfo)` Adds a `PassengerSegmentInfo` object to this template.
`PassengerSegmentInfoBuilder`	`addPassengerSegmentInfo(String segmentId, String passengerId, String seat, String seatType)` Adds a `PassengerSegmentInfo` object to this template.
`AirlineItineraryTemplateBuilder`	`addPriceInfo(PriceInfo priceInfo)` Adds a `PriceInfo` object to this template.
`AirlineItineraryTemplateBuilder`	`addPriceInfo(String title, BigDecimal amount)` Adds a `PriceInfo` object to this template.
`AirlineItineraryTemplateBuilder`	`addPriceInfo(String title, BigDecimal amount, String currency)` Adds a `PriceInfo` object to this template.
`AirlineItineraryTemplateBuilder`	`addQuickReply(QuickReply reply)` Adds a `QuickReply` to the current object.
`AirlineItineraryTemplateBuilder`	`addQuickReply(String title, String payload)` Adds a `QuickReply` to the current object.
`FbBotMillResponse`	`build(MessageEnvelope envelope)` Builds the `FbBotMillResponse` that the bot should return.
`AirlineItineraryTemplateBuilder`	`setBasePrice(BigDecimal basePrice)` Sets the base price for this itinerary.
`AirlineItineraryTemplateBuilder`	`setTax(BigDecimal tax)` Sets the tax amount for this itinerary.
`AirlineItineraryTemplateBuilder`	`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
  - setTax
```
public AirlineItineraryTemplateBuilder setTax(BigDecimal tax)
```
    Sets the tax amount for this itinerary. This field is optional.
    
    Parameters:
    
    tax - the tax amount.
    
    Returns:
    
    this builder.
  - setBasePrice
```
public AirlineItineraryTemplateBuilder setBasePrice(BigDecimal basePrice)
```
    Sets the base price for this itinerary. This field is optional.
    
    Parameters:
    
    basePrice - the base price.
    
    Returns:
    
    this builder.
  - addPassengerInfo
```
public AirlineItineraryTemplateBuilder addPassengerInfo(String passengerId,
                                                        String name,
                                                        String ticketNumber)
```
    Adds a PassengerInfo object to this template. This field is mandatory for this template. There must be at least one element.
    
    Parameters:
    
    passengerId - the passenger ID. It can't be empty.
    
    name - the passenger name. It can't be empty.
    
    ticketNumber - the ticket number. This field is optional.
    
    Returns:
    
    this builder.
  - addPassengerInfo
```
public AirlineItineraryTemplateBuilder addPassengerInfo(String passengerId,
                                                        String name)
```
    Adds a PassengerInfo object to this template. This field is mandatory for this template. There must be at least one element.
    
    Parameters:
    
    passengerId - the passenger ID. It can't be empty.
    
    name - the passenger name. It can't be empty.
    
    Returns:
    
    this builder.
  - addPassengerInfo
```
public AirlineItineraryTemplateBuilder addPassengerInfo(PassengerInfo passengerInfo)
```
    Adds a PassengerInfo object to this template. This field is mandatory for this template. There must be at least one element.
    
    Parameters:
    
    passengerInfo - the passenger info
    
    Returns:
    
    this builder.
  - addPassengerSegmentInfo
```
public PassengerSegmentInfoBuilder addPassengerSegmentInfo(String segmentId,
                                                           String passengerId,
                                                           String seat,
                                                           String seatType)
```
    Adds a PassengerSegmentInfo object to this template. This field is mandatory for this template. There must be at least one element.
    
    Parameters:
    
    segmentId - used to identify a flight segment. It can't be empty and must be unique within the itinerary.
    
    passengerId - the passengerId of PassengerInfo object. It can't be empty and it must match an actual passenger.
    
    seat - the seat number for the passenger. It can't be empty.
    
    seatType - the seat type for the passenger (e.g. Economy comfort). It can't be empty.
    
    Returns:
    
    the passenger segment info builder
  - addPassengerSegmentInfo
```
public AirlineItineraryTemplateBuilder addPassengerSegmentInfo(PassengerSegmentInfo segmentInfo)
```
    Adds a PassengerSegmentInfo object to this template. This field is mandatory for this template. There must be at least one element.
    
    Parameters:
    
    segmentInfo - the segment info to add.
    
    Returns:
    
    this builder.
  - addPriceInfo
```
public AirlineItineraryTemplateBuilder addPriceInfo(String title,
                                                    BigDecimal amount)
```
    Adds a PriceInfo object to this template. This field is optional. There can be at most 4 price info objects per template.
    
    Parameters:
    
    title - the price info title. It can't be empty.
    
    amount - the price amount.
    
    Returns:
    
    this builder.
  - addPriceInfo
```
public AirlineItineraryTemplateBuilder addPriceInfo(String title,
                                                    BigDecimal amount,
                                                    String currency)
```
    Adds a PriceInfo object to this template. This field is optional. There can be at most 4 price info objects per template.
    
    Parameters:
    
    title - the price info title. It can't be empty.
    
    amount - the price amount.
    
    currency - the pricing currency. This field is optional. Currency must be a three digit ISO-4217-3 code in format [A-Z]{3}. For more information see Facebook's currency support
    
    Returns:
    
    this builder.
  - addPriceInfo
```
public AirlineItineraryTemplateBuilder addPriceInfo(PriceInfo priceInfo)
```
    Adds a PriceInfo object to this template. This field is optional. There can be at most 4 price info objects per template.
    
    Parameters:
    
    priceInfo - the price info object to add.
    
    Returns:
    
    this builder.
  - addFlightInfo
```
public FlightInfoExtendedBuilder addFlightInfo(String flightNumber,
                                               String connectionId,
                                               String segmentId,
                                               TravelClass travelClass)
```
    Adds a FlightInfoExtended 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.
    
    connectionId - the connection ID, used to group together segments. It can't be empty.
    
    segmentId - the segment ID. It must match the segment ID.
    
    travelClass - the travel class. It can't be null.
    
    Returns:
    
    a builder for the FlightInfoExtended object.
  - addFlightInfo
```
public AirlineItineraryTemplateBuilder addFlightInfo(FlightInfoExtended flightInfo)
```
    Adds a FlightInfoExtended 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:
    
    flightInfo - the flight info to add.
    
    Returns:
    
    this builder.
  - setThemeColor
```
public AirlineItineraryTemplateBuilder 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 AirlineItineraryTemplateBuilder 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 AirlineItineraryTemplateBuilder 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

Class AirlineItineraryTemplateBuilder

Field Summary

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

Method Summary

Methods inherited from class co.aurasphere.botmill.fb.model.outcoming.factory.FbBotMillResponseBuilder

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

Methods inherited from class java.lang.Object

Method Detail

setTax

setBasePrice

addPassengerInfo

addPassengerInfo

addPassengerInfo

addPassengerSegmentInfo

addPassengerSegmentInfo

addPriceInfo

addPriceInfo

addPriceInfo

addFlightInfo

addFlightInfo

setThemeColor

addQuickReply

addQuickReply

build

toString