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

Class GenericTemplateElementBuilder

java.lang.Object

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

public class GenericTemplateElementBuilder
extends Object

Builder for a GenericTemplateElement.

Author:

Donato Rimenti

Method Summary

Modifier and Type	Method and Description
GenericTemplateElementBuilder	addButton(Button button) Adds a button to the current GenericTemplateElement.
GenericTemplateElementBuilder	addBuyButton(String payload, PaymentSummary paymentSummary) Adds a buy button on a generic template.
GenericTemplateElementBuilder	addLoginButton(String url) Adds a login button on a generic template.
GenericTemplateElementBuilder	addLogoutButton() Adds a logout button on a generic template.
GenericTemplateElementBuilder	addPhoneNumberButton(String title, String phoneNumber) Adds a button with a phone number to the current GenericTemplateElement.
GenericTemplateElementBuilder	addPostbackButton(String title, String payload) Adds a button which sends a payload back when clicked to the current GenericTemplateElement.
GenericTemplateElementBuilder	addShareButton() Adds a share button on a generic template.
GenericTemplateElementBuilder	addUrlButton(String title, String url) Adds a button which redirects to an URL when clicked to the current GenericTemplateElement.
GenericTemplateElementBuilder	addUrlButton(String title, String url, WebViewHeightRatioType ratioType) Adds a button which redirects to an URL when clicked to the current GenericTemplateElement.
GenericTemplateBuilder	endElement() Builds the current object, adds it to the parent builder and returns the parent builder.
GenericTemplateElementBuilder	setImage(String imageUrl) Sets an image for the current GenericTemplateElement.
GenericTemplateElementBuilder	setRedirectUrl(String itemUrl) Sets an URL for the current GenericTemplateElement.
GenericTemplateElementBuilder	setSubtitle(String subtitle) Sets a subtitle for the current GenericTemplateElement.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

setSubtitle

public GenericTemplateElementBuilder setSubtitle(String subtitle)

Sets a subtitle for the current GenericTemplateElement.

Parameters:

subtitle - the subtitle to set.

Returns:

this builder.

setImage

public GenericTemplateElementBuilder setImage(String imageUrl)

Sets an image for the current GenericTemplateElement.

Parameters:

imageUrl - the image url

Returns:

this builder.

setRedirectUrl

public GenericTemplateElementBuilder setRedirectUrl(String itemUrl)

Sets an URL for the current GenericTemplateElement. The URL will be used to redirect the user when the element is clicked.

Parameters:

itemUrl - the item url

Returns:

this builder.

addUrlButton

public GenericTemplateElementBuilder addUrlButton(String title,
                                                  String url)

Adds a button which redirects to an URL when clicked to the current GenericTemplateElement. There can be at most 3 buttons per element.

Parameters:

title - the button label.

url - the URL to whom redirect when clicked.

Returns:

this builder.

addUrlButton

public GenericTemplateElementBuilder addUrlButton(String title,
                                                  String url,
                                                  WebViewHeightRatioType ratioType)

Adds a button which redirects to an URL when clicked to the current GenericTemplateElement. There can be at most 3 buttons per element.

Parameters:

title - the button label.

url - the URL to whom redirect when clicked.

ratioType - the ratioType.

Returns:

this builder.

addPhoneNumberButton

public GenericTemplateElementBuilder addPhoneNumberButton(String title,
                                                          String phoneNumber)

Adds a button with a phone number to the current GenericTemplateElement. There can be at most 3 buttons per element.

Parameters:

title - the button label.

phoneNumber - a phone number. Must be in the format '+' prefix followed by the country code, area code and local number.

Returns:

this builder.

addPostbackButton

public GenericTemplateElementBuilder addPostbackButton(String title,
                                                       String payload)

Adds a button which sends a payload back when clicked to the current GenericTemplateElement. There can be at most 3 buttons per element.

Parameters:

title - the button label.

payload - the payload to send back when clicked.

Returns:

this builder.

addButton

public GenericTemplateElementBuilder addButton(Button button)

Adds a button to the current GenericTemplateElement. There can be at most 3 buttons per element.

Parameters:

button - the button to add.

Returns:

this builder.

addShareButton

public GenericTemplateElementBuilder addShareButton()

Adds a share button on a generic template.

Returns:

this builder.

addLoginButton

public GenericTemplateElementBuilder addLoginButton(String url)

Adds a login button on a generic template.

Parameters:

url - the url

Returns:

this builder.

addLogoutButton

public GenericTemplateElementBuilder addLogoutButton()

Adds a logout button on a generic template.

Returns:

this builder.

addBuyButton

public GenericTemplateElementBuilder addBuyButton(String payload,
                                                  PaymentSummary paymentSummary)

Adds a buy button on a generic template.

Parameters:

payload - the payload

paymentSummary - the payment summary

Returns:

this builder.

endElement

public GenericTemplateBuilder endElement()

Builds the current object, adds it to the parent builder and returns the parent builder.

Returns:

the parent builder of this builder.

toString

public String toString()

Overrides:

toString in class Object