ReplyFactory (FB-BotMill 2.0.0-RC3 API)

java.lang.Object
- co.aurasphere.botmill.fb.model.outcoming.factory.ReplyFactory

```
public class ReplyFactory
extends Object
```
Static class that allows the creation of a FbBotMillResponse.

Author:

Donato Rimenti, Alvin Reyes

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AirlineBoardingPassTemplateBuilder`	`addAirlineBoardingPassTemplate(String introMessage, String locale)` Adds an Airline Boarding Pass Template to the response.
`static AirlineCheckinTemplateBuilder`	`addAirlineCheckinTemplate(String introMessage, String locale, String pnrNumber, String checkinUrl)` Adds an Airline Checkin Template to the response.
`static AirlineFlightUpdateTemplateBuilder`	`addAirlineFlightUpdateTemplate(String introMessage, String locale, String pnrNumber, UpdateType updateType)` Adds an Airline Flight Update Template to the response.
`static AirlineItineraryTemplateBuilder`	`addAirlineItineraryTemplate(String introMessage, String locale, String pnrNumber, BigDecimal totalPrice, String currency)` Adds an Airline Itinerary Template to the response.
`static ReceiptTemplateBuilder`	`addAirlineItineraryTemplate(String recipientName, String orderNumber, String currency, String paymentMethod)` Adds a Receipt Template to the response.
`static AttachmentMessageBuilder`	`addAudioAttachment(String url)` Adds an audio attachment to the response.
`static ButtonTemplateBuilder`	`addButtonTemplate(String message)` Adds a Button Template to the response.
`static AttachmentMessageBuilder`	`addFileAttachment(String url)` Adds a file attachment to the response.
`static GenericTemplateBuilder`	`addGenericTemplate()` Adds a Generic Template to the response.
`static AttachmentMessageBuilder`	`addImageAttachment(String url)` Adds an image attachment to the response.
`static ListTemplateBuilder`	`addListTemplate()` Adds a List Template to the response.
`static ReceiptTemplateBuilder`	`addReceiptTemplate(String recipientName, String orderNumber, String currency, String paymentMethod)` Adds a Receipt Template to the response.
`static TextMessageBuilder`	`addTextMessageOnly(String message)` Creates a response which contains only a text message.
`static ActionResponseBuilder`	`addTypingAction(TypingAction action)` Adds a `TypingAction` to the response.
`static AttachmentMessageBuilder`	`addVideoAttachment(String url)` Adds a video attachment to the response.
`static AttachmentMessageBuilder`	`getReusableAudioAttachment(String attachmentId)` Get the reusable audio attachment
`static AttachmentMessageBuilder`	`getReusableFileAttachment(String attachmentId)` Get the reusable file attachment
`static AttachmentMessageBuilder`	`getReusableImageAttachment(String attachmentId)` Get the reusable image attachment
`static AttachmentMessageBuilder`	`getReusableVideoAttachment(String attachmentId)` Get the reusable video attachment
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - addTypingAction
```
public static ActionResponseBuilder addTypingAction(TypingAction action)
```
    Adds a TypingAction to the response.
    
    Parameters:
    
    action - the action to add. Can't be null.
    
    Returns:
    
    a builder for that action.
    
    See Also:
    
    Facebook's Messenger Platform Sender Actions Documentation
  - addButtonTemplate
```
public static ButtonTemplateBuilder addButtonTemplate(String message)
```
    Adds a Button Template to the response.
    
    Parameters:
    
    message - the message of the Button Template.
    
    Returns:
    
    a builder for the template.
    
    See Also:
    
    Facebook's Messenger Platform Button Template Documentation
  - addGenericTemplate
```
public static GenericTemplateBuilder addGenericTemplate()
```
    Adds a Generic Template to the response.
    
    Returns:
    
    a builder for the template.
    
    See Also:
    
    Facebook's Messenger Platform Generic Template Documentation
  - addListTemplate
```
public static ListTemplateBuilder addListTemplate()
```
    Adds a List Template to the response.
    
    Returns:
    
    a builder for the template.
    
    See Also:
    
    Facebook's Messenger Platform List Template Documentation
  - addTextMessageOnly
```
public static TextMessageBuilder addTextMessageOnly(String message)
```
    Creates a response which contains only a text message.
    
    Parameters:
    
    message - the message to create.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Text Message Documentation
  - addImageAttachment
```
public static AttachmentMessageBuilder addImageAttachment(String url)
```
    Adds an image attachment to the response.
    
    Parameters:
    
    url - the url of the image to attach.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Image Attachment Documentation
  - getReusableImageAttachment
```
public static AttachmentMessageBuilder getReusableImageAttachment(String attachmentId)
```
    Get the reusable image attachment
    
    Parameters:
    
    attachmentId - the attachment id generated by the upload api
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Image Attachment Documentation
  - addAudioAttachment
```
public static AttachmentMessageBuilder addAudioAttachment(String url)
```
    Adds an audio attachment to the response.
    
    Parameters:
    
    url - the url of the audio to attach.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Audio Attachment Documentation
  - getReusableAudioAttachment
```
public static AttachmentMessageBuilder getReusableAudioAttachment(String attachmentId)
```
    Get the reusable audio attachment
    
    Parameters:
    
    attachmentId - the attachment id generated by the upload api
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Audio Attachment Documentation
  - addVideoAttachment
```
public static AttachmentMessageBuilder addVideoAttachment(String url)
```
    Adds a video attachment to the response.
    
    Parameters:
    
    url - the url of the video to attach.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Video Attachment Documentation
  - getReusableVideoAttachment
```
public static AttachmentMessageBuilder getReusableVideoAttachment(String attachmentId)
```
    Get the reusable video attachment
    
    Parameters:
    
    attachmentId - the attachment id generated by the upload api
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Video Attachment Documentation
  - addFileAttachment
```
public static AttachmentMessageBuilder addFileAttachment(String url)
```
    Adds a file attachment to the response.
    
    Parameters:
    
    url - the url of the file to attach.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform File Attachment Documentation
  - getReusableFileAttachment
```
public static AttachmentMessageBuilder getReusableFileAttachment(String attachmentId)
```
    Get the reusable file attachment
    
    Parameters:
    
    attachmentId - the attachment id generated by the upload api
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform File Attachment Documentation
  - addAirlineItineraryTemplate
```
public static ReceiptTemplateBuilder addAirlineItineraryTemplate(String recipientName,
                                                                 String orderNumber,
                                                                 String currency,
                                                                 String paymentMethod)
```
    Adds a Receipt Template to the response.
    
    Parameters:
    
    recipientName - the recipient's name.
    
    orderNumber - the order number.Must be unique for each user.
    
    currency - the currency for the price. It can't be empty. The currency must be a three digit ISO-4217-3 code in format [A-Z]{3}. For more information see Facebook's currency support
    
    paymentMethod - the payment method details. This can be a custom string. ex: "Visa 1234". You may insert an arbitrary string here but we recommend providing enough information for the person to decipher which payment method and account they used (e.g., the name of the payment method and partial account number).
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Receipt Template Documentation
  - addAirlineItineraryTemplate
```
public static AirlineItineraryTemplateBuilder addAirlineItineraryTemplate(String introMessage,
                                                                          String locale,
                                                                          String pnrNumber,
                                                                          BigDecimal totalPrice,
                                                                          String currency)
```
    Adds an Airline Itinerary Template to the response.
    
    Parameters:
    
    introMessage - the message to send before the template. It can't be empty.
    
    locale - the current locale. It can't be empty and must be in format [a-z]{2}_[A-Z]{2}. Locale must be in format [a-z]{2}_[A-Z]{2}. For more information see Facebook's locale support.
    
    pnrNumber - the Passenger Name Record number (Booking Number). It can't be empty.
    
    totalPrice - the total price of the itinerary.
    
    currency - the currency for the price. It can't be empty. The currency must be a three digit ISO-4217-3 code in format [A-Z]{3}. For more information see Facebook's currency support
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Airline Itinerary Template Documentation
  - addAirlineCheckinTemplate
```
public static AirlineCheckinTemplateBuilder addAirlineCheckinTemplate(String introMessage,
                                                                      String locale,
                                                                      String pnrNumber,
                                                                      String checkinUrl)
```
    Adds an Airline Checkin Template to the response.
    
    Parameters:
    
    introMessage - the message to send before the template. It can't be empty.
    
    locale - the current locale. It can't be empty and must be in format [a-z]{2}_[A-Z]{2}. Locale must be in format [a-z]{2}_[A-Z]{2}. For more information see Facebook's locale support.
    
    pnrNumber - the Passenger Name Record number (Booking Number). It can't be empty.
    
    checkinUrl - the url for the checkin. It can't be empty.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Airline Checkin Template Documentation
  - addAirlineBoardingPassTemplate
```
public static AirlineBoardingPassTemplateBuilder addAirlineBoardingPassTemplate(String introMessage,
                                                                                String locale)
```
    Adds an Airline Boarding Pass Template to the response.
    
    Parameters:
    
    introMessage - the message to send before the template. It can't be empty.
    
    locale - the current locale. It can't be empty and must be in format [a-z]{2}_[A-Z]{2}. Locale must be in format [a-z]{2}_[A-Z]{2}. For more information see Facebook's locale support.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Airline Boarding Pass Template Documentation
  - addAirlineFlightUpdateTemplate
```
public static AirlineFlightUpdateTemplateBuilder addAirlineFlightUpdateTemplate(String introMessage,
                                                                                String locale,
                                                                                String pnrNumber,
                                                                                UpdateType updateType)
```
    Adds an Airline Flight Update Template to the response.
    
    Parameters:
    
    introMessage - the message to send before the template. It can't be empty.
    
    locale - the current locale. It can't be empty and must be in format [a-z]{2}_[A-Z]{2}. Locale must be in format [a-z]{2}_[A-Z]{2}. For more information see Facebook's locale support.
    
    pnrNumber - the Passenger Name Record number (Booking Number). It can't be empty.
    
    updateType - an UpdateType object that represents the kind of status update of the flight. It can't be null.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Airline Flight Update Template Documentation
  - addReceiptTemplate
```
public static ReceiptTemplateBuilder addReceiptTemplate(String recipientName,
                                                        String orderNumber,
                                                        String currency,
                                                        String paymentMethod)
```
    Adds a Receipt Template to the response.
    
    Parameters:
    
    recipientName - the recipient name. It can't be empty.
    
    orderNumber - the order number. It can't be empty and it must be unique for each user.
    
    currency - the currency for order. It can't be empty.
    
    paymentMethod - the payment method details. This can be a custom string. ex: "Visa 1234". You may insert an arbitrary string here but we recommend providing enough information for the person to decipher which payment method and account they used (e.g., the name of the payment method and partial account number). It can't be empty.
    
    Returns:
    
    a builder for the response.
    
    See Also:
    
    Facebook's Messenger Platform Receipt Template Documentation
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ReplyFactory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addTypingAction

addButtonTemplate

addGenericTemplate

addListTemplate

addTextMessageOnly

addImageAttachment

getReusableImageAttachment

addAudioAttachment

getReusableAudioAttachment

addVideoAttachment

getReusableVideoAttachment

addFileAttachment

getReusableFileAttachment

addAirlineItineraryTemplate

addAirlineItineraryTemplate

addAirlineCheckinTemplate

addAirlineBoardingPassTemplate

addAirlineFlightUpdateTemplate

addReceiptTemplate

toString