co.aurasphere.botmill.fb.threadsettings

Class FbBotMillThreadSettingsConfiguration

java.lang.Object

co.aurasphere.botmill.fb.threadsettings.FbBotMillThreadSettingsConfiguration

public class FbBotMillThreadSettingsConfiguration
extends Object

Class which handles the configuration of the Facebook Messenger Platform Thread Settings (for more informations, see the link below). The methods of this class needs to be called only once and thus shouldn't be put on the class that implements FbBotDefinition. The best way of handling the configuration would be defining your own class with a main method and put the call on it.

Author:

Donato Rimenti

See Also:

Facebook's Thread Settings Documentation

Constructor Summary

Constructors

Constructor and Description
FbBotMillThreadSettingsConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addWhiteListDomain(String domain) Add a single domain on the list of domains that needs to be "white listed".
static void	deleteGetStartedButton() Removes the current Get Started Button.
static void	deletePersistentMenu() Removes the current Persistent Menu.
static void	deleteWhiteListDomains(List<String> whiteListDomains) Removes a list of domains that are currently "white listed".
static void	setGetStartedButton(String payload) Sets the Get Started Button for the bot.
static void	setGreetingMessage(String message) Sets the greeting message for the bot.
static void	setPersistentMenu(List<Button> buttons) Sets a Persistent Menu of buttons which is always available to the user.
static void	setWhiteListDomains(List<String> whiteListDomains) Add a list of domains that needs to be "white listed".

Methods inherited from class java.lang.Object

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

Constructor Detail

FbBotMillThreadSettingsConfiguration

public FbBotMillThreadSettingsConfiguration()

Method Detail

setGreetingMessage

public static void setGreetingMessage(String message)

Sets the greeting message for the bot. The Greeting Text is only rendered the first time the user interacts with a the Page on Messenger.

Parameters:

message - the greeting message to show.

See Also:

Facebook's Greeting Text Documentation

setGetStartedButton

public static void setGetStartedButton(String payload)

Sets the Get Started Button for the bot. The Get Started button is only rendered the first time the user interacts with a the Page on Messenger. When this button is tapped, the defined payload will be sent back with a postback received callback.

Parameters:

payload - the payload to return when the button is tapped.

See Also:

Facebook's Get Started Button Documentation

deleteGetStartedButton

public static void deleteGetStartedButton()

Removes the current Get Started Button.

See Also:

#setGetStartedButton(String)}

setPersistentMenu

public static void setPersistentMenu(List<Button> buttons)

Sets a Persistent Menu of buttons which is always available to the user. This menu should contain top-level actions that users can enact at any point. Having a persistent menu easily communicates the basic capabilities of your bot for first-time and returning users. The menu can be invoked by a user, by tapping on the 3-caret icon on the left of the composer.

Parameters:

buttons - a list of Button (max 5 elements) to use as menu. The buttons can only be PostbackButton or WebUrlButton. Phone buttons are not supported.

See Also:

Facebook's Persistent Menu Documentation

deletePersistentMenu

public static void deletePersistentMenu()

Removes the current Persistent Menu.

See Also:

#setPersistentMenu(List)}

setWhiteListDomains

public static void setWhiteListDomains(List<String> whiteListDomains)

Add a list of domains that needs to be "white listed".

Parameters:

whiteListDomains - the list of domains in String.

addWhiteListDomain

public static void addWhiteListDomain(String domain)

Add a single domain on the list of domains that needs to be "white listed".

Parameters:

domain - the domain that needs to be "white listed"

deleteWhiteListDomains

public static void deleteWhiteListDomains(List<String> whiteListDomains)

Removes a list of domains that are currently "white listed".

Parameters:

whiteListDomains - the list of domains that needs to be removed.