co.aurasphere.botmill.fb.api

Class MessengerProfileApi

java.lang.Object

co.aurasphere.botmill.fb.api.MessengerProfileApi

public class MessengerProfileApi
extends Object

Class which handles the configuration of the Facebook Messenger Platform Messenger Profile (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 BotDefinition. 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 Messenger Profile Documentation

Method Summary

Modifier and Type	Method and Description
static void	deleteAccountLinkingUrl() Removes the URL used for account linking.
static void	deleteGetStartedButton() Removes the current Get Started Button.
static void	deleteGreetingMessage() Removes the current Greeting Message.
static void	deleteHomeUrl() Removes the home url.
static void	deletePersistentMenus() Removes the Persistent Menus.
static void	deleteWhitelistedDomains() Removes the list of domains that are currently whitelisted.
static void	setAccountLinkingUrl(String accountLinkingUrl) Adds an URL used for account linking.
static void	setGetStartedButton(String payload) Sets the Get Started Button for the bot.
static void	setGreetingMessage(List<Greeting> message) Sets the greeting message for the bot.
static void	setGreetingMessage(String message) Sets the greeting message for the bot.
static void	setHomeUrl(HomeUrl homeUrl) This sets the home url of the Bot
static void	setPersistentMenus(List<PersistentMenu> persistentMenu) Sets the persistent menus.
static void	setWhitelistedDomains(List<String> whitelistedDomains) Adds a list of domains that needs to be whitelisted.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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 Messenger Platform Get Started Button Documentation

deleteGetStartedButton

public static void deleteGetStartedButton()

Removes the current Get Started Button.

See Also:

setGetStartedButton(String)

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 Messenger Platform Greeting Text Documentation

setGreetingMessage

public static void setGreetingMessage(List<Greeting> 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 messages to show.

See Also:

Facebook's Messenger Platform Greeting Text Documentation

deleteGreetingMessage

public static void deleteGreetingMessage()

Removes the current Greeting Message.

See Also:

setGreetingMessage(String)

setWhitelistedDomains

public static void setWhitelistedDomains(List<String> whitelistedDomains)

Adds a list of domains that needs to be whitelisted.

Parameters:

whitelistedDomains - the list of domains to whitelist.

See Also:

Facebook's Messenger Platform Domain Whitelisting Documentation

deleteWhitelistedDomains

public static void deleteWhitelistedDomains()

Removes the list of domains that are currently whitelisted.

See Also:

Facebook's Messenger Platform Domain Whitelisting Documentation

setAccountLinkingUrl

public static void setAccountLinkingUrl(String accountLinkingUrl)

Adds an URL used for account linking.

Parameters:

accountLinkingUrl - the URL for the account linking.

See Also:

Facebook's Messenger Platform Account Linking URL Documentation

deleteAccountLinkingUrl

public static void deleteAccountLinkingUrl()

Removes the URL used for account linking.

See Also:

Facebook's Messenger Platform Account Linking URL Documentation

setPersistentMenus

public static void setPersistentMenus(List<PersistentMenu> persistentMenu)

Sets the persistent menus.

Parameters:

persistentMenu - the new persistent menus

See Also:

Facebook's Messenger Platform Persistent Menu Documentation

deletePersistentMenus

public static void deletePersistentMenus()

Removes the Persistent Menus.

See Also:

Facebook's Messenger Platform Persistent Menu Documentation

setHomeUrl

public static void setHomeUrl(HomeUrl homeUrl)

This sets the home url of the Bot

Parameters:

homeUrl -

See Also:

Chat Extension Home URL

deleteHomeUrl

public static void deleteHomeUrl()

Removes the home url.

See Also:

Chat Extension Home URL

toString

public String toString()

Overrides:

toString in class Object