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

Class ListTemplateElementBuilder

java.lang.Object

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

public class ListTemplateElementBuilder
extends Object

Builder for a ListTemplateElement.

Author:

Alvin Reyes

Method Summary

Modifier and Type	Method and Description
ListTemplateElementBuilder	addButton(Button button) Adds a button to the current ListTemplateElement.
ListTemplateElementBuilder	addPhoneNumberButton(String title, String phoneNumber) Adds a button with a phone number to the current ListTemplateElement.
ListTemplateElementBuilder	addPostbackButton(String title, String payload) Adds a button which sends a payload back when clicked to the current ListTemplateElement.
ListTemplateElementBuilder	addUrlButton(String title, String url) Adds a button which redirects to an URL when clicked to the current ListTemplateElement.
ListTemplateBuilder	endElement() Builds the current object, adds it to the parent builder and returns the parent builder.
ListTemplateElementBuilder	setDefaultAction(DefaultAction defaultAction) Sets a DefaultAction for the current ListTemplateElement.
ListTemplateElementBuilder	setImageUrl(String imageUrl) Sets an image for the current ListTemplateElement.
ListTemplateElementBuilder	setSubtitle(String subtitle) Sets a subtitle for the current ListTemplateElement.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

setSubtitle

public ListTemplateElementBuilder setSubtitle(String subtitle)

Sets a subtitle for the current ListTemplateElement.

Parameters:

subtitle - the subtitle to set.

Returns:

this builder.

setImageUrl

public ListTemplateElementBuilder setImageUrl(String imageUrl)

Sets an image for the current ListTemplateElement.

Parameters:

imageUrl - the image url

Returns:

this builder.

setDefaultAction

public ListTemplateElementBuilder setDefaultAction(DefaultAction defaultAction)

Sets a DefaultAction for the current ListTemplateElement. You can use the ButtonFactory.createDefaultActionButton(String) method to create one.

Parameters:

defaultAction - the default action

Returns:

this builder.

addUrlButton

public ListTemplateElementBuilder addUrlButton(String title,
                                               String url)

Adds a button which redirects to an URL when clicked to the current ListTemplateElement. 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.

addPhoneNumberButton

public ListTemplateElementBuilder addPhoneNumberButton(String title,
                                                       String phoneNumber)

Adds a button with a phone number to the current ListTemplateElement. 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 ListTemplateElementBuilder addPostbackButton(String title,
                                                    String payload)

Adds a button which sends a payload back when clicked to the current ListTemplateElement. 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 ListTemplateElementBuilder addButton(Button button)

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

Parameters:

button - the button to add.

Returns:

this builder.

endElement

public ListTemplateBuilder 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