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

Class ReceiptTemplateBuilder

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

public class ReceiptTemplateBuilder
extends TemplateBaseBuilder

A builder for a Receipt Template.

Author:

Donato Rimenti

See Also:

Facebook's Messenger Platform Receipt 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
ReceiptTemplateBuilder	addAdjustment(Adjustment adjustment) Adds an Adjustment to this builder.
ReceiptTemplateBuilder	addAdjustment(String name, BigDecimal amount) Adds an Adjustment to this builder.
ReceiptTemplateBuilder	addElement(ReceiptTemplateElement element) Adds a ReceiptTemplateElement to this template.
ReceiptTemplateElementBuilder	addElement(String title) Adds a ReceiptTemplateElement to this template.
ReceiptTemplateBuilder	addQuickReply(QuickReply reply) Adds a QuickReply to the current object.
ReceiptTemplateBuilder	addQuickReply(String title, String payload) Adds a QuickReply to the current object.
FbBotMillResponse	build(MessageEnvelope envelope) Builds the FbBotMillResponse that the bot should return.
AddressBuilder	setAddress() The shipping address.
ReceiptTemplateBuilder	setAddress(Address address) The shipping address.
ReceiptTemplateBuilder	setMerchantName(String merchantName) Sets the merchant name.
ReceiptTemplateBuilder	setOrderUrl(String orderUrl) Sets the URL of order.
ReceiptTemplateBuilder	setSummary(BigDecimal subtotal, BigDecimal shippingCost, BigDecimal totalTax, BigDecimal totalCost) Sets the payment Summary.
ReceiptTemplateBuilder	setSummary(Summary summary) Sets the payment Summary.
ReceiptTemplateBuilder	setTimestamp(String timestamp) Sets the timestamp of the order, in seconds.
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, getLocationMessage, 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

setMerchantName

public ReceiptTemplateBuilder setMerchantName(String merchantName)

Sets the merchant name. If present this is shown as logo text.

Parameters:

merchantName - the merchant name to set.

Returns:

this builder.

setTimestamp

public ReceiptTemplateBuilder setTimestamp(String timestamp)

Sets the timestamp of the order, in seconds.

Parameters:

timestamp - the timestamp to set.

Returns:

this builder.

setOrderUrl

public ReceiptTemplateBuilder setOrderUrl(String orderUrl)

Sets the URL of order.

Parameters:

orderUrl - the URL of order to set.

Returns:

this builder.

addElement

public ReceiptTemplateBuilder addElement(ReceiptTemplateElement element)

Adds a ReceiptTemplateElement to this template. This field can't be empty. The elements must be at most 100 and the sorting is not guaranteed.

Parameters:

element - the element to add.

Returns:

this builder.

addElement

public ReceiptTemplateElementBuilder addElement(String title)

Adds a ReceiptTemplateElement to this template. This field can't be empty. The elements must be at most 100 and the sorting is not guaranteed.

Parameters:

title - the title of the item. This field is mandatory and can't be empty or null.

Returns:

a ReceiptTemplateElementBuilder for building the element.

setAddress

public ReceiptTemplateBuilder setAddress(Address address)

The shipping address. The address is optional. If you do not ship an item, you may omit these fields.

Parameters:

address - the address to set.

Returns:

this builder.

setAddress

public AddressBuilder setAddress()

The shipping address. The address is optional. If you do not ship an item, you may omit these fields.

Returns:

an AddressBuilder to build the address.

setSummary

public ReceiptTemplateBuilder setSummary(Summary summary)

Sets the payment Summary. This field is required and can't be null.

Parameters:

summary - the summary to set.

Returns:

this builder.

setSummary

public ReceiptTemplateBuilder setSummary(BigDecimal subtotal,
                                         BigDecimal shippingCost,
                                         BigDecimal totalTax,
                                         BigDecimal totalCost)

Sets the payment Summary. This field is required and can't be null. These numbers should be valid and well formatted decimal numbers, using '.' (dot) as the decimal separator. Note that most currencies only accept up to 2 decimal places.

Parameters:

subtotal - the subtotal.

shippingCost - the cost of the shipping.

totalTax - the total tax.

totalCost - the total cost.

Returns:

this builder.

addAdjustment

public ReceiptTemplateBuilder addAdjustment(Adjustment adjustment)

Adds an Adjustment to this builder. Adjustments allow a way to insert adjusted pricing (e.g., sales). Adjustments are optional.

Parameters:

adjustment - the adjustment to add.

Returns:

this builder.

addAdjustment

public ReceiptTemplateBuilder addAdjustment(String name,
                                            BigDecimal amount)

Adds an Adjustment to this builder. Adjustments allow a way to insert adjusted pricing (e.g., sales). Adjustments are optional.

Parameters:

name - the name of the adjustment.

amount - the amount of the adjustment.

Returns:

this builder.

addQuickReply

public ReceiptTemplateBuilder 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 ReceiptTemplateBuilder 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. Creates a response containing a Receipt Template.

Parameters:

envelope - a MessageEnvelope object representing the incoming message.

Returns:

the FbBotMillResponse of this bot.

toString

public String toString()

Overrides:

toString in class TemplateBaseBuilder