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

Method Summary

Methods

Modifier and Type	Method and Description
static void	addPaymentSettings(PaymentSettings paymentSettings) This method is used to add any payment settings needed.
static void	addPaymentsTester(String paymentTesterId) Adds a single tester for payments.
static void	addPaymentsTesters(List<String> paymentTestersIds) Adds a list of testers for payments.
static void	addWhiteListDomain(String domain) Adds 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	deleteWhiteListDomain(String domain) Removes a single domain on the list of domains that needs to be "white listed".
static void	deleteWhiteListDomains(List<String> whiteListDomains) Removes a list of domains that are currently "white listed".
static void	removePaymentsTester(String paymentTesterId) Removes a single tester for payments.
static void	removePaymentsTesters(List<String> paymentTestersIds) Removes a list of testers for payments.
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	setPaymentsPrivacyUrl(String privacyUrl) Sets the payment privacy Url.
static void	setPaymentsPublicKey(String publicKey) Sets the payment public key.
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) Adds a list of domains that needs to be "white listed".
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

addPaymentSettings

public static void addPaymentSettings(PaymentSettings paymentSettings)

This method is used to add any payment settings needed.

Parameters:

paymentSettings - the payment settings object.

See Also:

Payments settings

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)

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

Parameters:

whiteListDomains - the list of domains in String.

See Also:

Facebook's Messenger Platform Domain Whitelisting Thread Settings Documentation

addWhiteListDomain

public static void addWhiteListDomain(String domain)

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

Parameters:

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

See Also:

Facebook's Messenger Platform Domain Whitelisting Thread Settings Documentation

deleteWhiteListDomain

public static void deleteWhiteListDomain(String domain)

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

Parameters:

domain - the domain that needs to be removed.

See Also:

Facebook's Messenger Platform Domain Whitelisting Thread Settings Documentation

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.

See Also:

Facebook's Messenger Platform Domain Whitelisting Thread Settings Documentation

addPaymentsTesters

public static void addPaymentsTesters(List<String> paymentTestersIds)

Adds a list of testers for payments. You can add payment test users so that their credit card won't be charged during your development. Once added, it will impact both Buy Button and Webview Extension integrations, any payment send to these users will be a dummy charge. If you are only testing BuyButton, consider using the PaymentSummary.setTestPayment(boolean) flag which is simpler for testing.

Parameters:

paymentTestersIds - the testers app-scoped IDs to add to the testers list.

Since:

1.2.0

See Also:

Facebook's Messenger Platform Payments Thread Settings Documentation

addPaymentsTester

public static void addPaymentsTester(String paymentTesterId)

Adds a single tester for payments. You can add payment test users so that their credit card won't be charged during your development. Once added, it will impact both Buy Button and Webview Extension integrations, any payment send to these users will be a dummy charge. If you are only testing BuyButton, consider using the PaymentSummary.setTestPayment(boolean) flag which is simpler for testing.

Parameters:

paymentTesterId - the tester app-scoped ID to add to the testers list.

Since:

1.2.0

See Also:

Facebook's Messenger Platform Payments Thread Settings Documentation

removePaymentsTester

public static void removePaymentsTester(String paymentTesterId)

Removes a single tester for payments. You can add payment test users so that their credit card won't be charged during your development. Once added, it will impact both Buy Button and Webview Extension integrations, any payment send to these users will be a dummy charge. If you are only testing BuyButton, consider using the PaymentSummary.setTestPayment(boolean) flag which is simpler for testing.

Parameters:

paymentTesterId - the tester app-scoped ID to remove from the testers list.

Since:

1.2.0

See Also:

Facebook's Messenger Platform Payments Thread Settings Documentation

removePaymentsTesters

public static void removePaymentsTesters(List<String> paymentTestersIds)

Removes a list of testers for payments. You can add payment test users so that their credit card won't be charged during your development. Once added, it will impact both Buy Button and Webview Extension integrations, any payment send to these users will be a dummy charge. If you are only testing BuyButton, consider using the PaymentSummary.setTestPayment(boolean) flag which is simpler for testing.

Parameters:

paymentTestersIds - the testers app-scoped IDs to remove from the testers list.

Since:

1.2.0

See Also:

Facebook's Messenger Platform Payments Thread Settings Documentation

setPaymentsPublicKey

public static void setPaymentsPublicKey(String publicKey)

Sets the payment public key. The payment_public_key is used to encrypt sensitive payment data sent to you.

Parameters:

publicKey - the public key to set.

Since:

1.2.0

See Also:

Facebook's Messenger Platform Payments Thread Settings Documentation, Facebook's Messenger Platform Creating Encryption Documentation

setPaymentsPrivacyUrl

public static void setPaymentsPrivacyUrl(String privacyUrl)

Sets the payment privacy Url. The payment_privacy_url will appear in Facebook's payment dialogs and people will be able to view these terms.

Parameters:

privacyUrl - the privacy Url to set.

Since:

1.2.0

See Also:

Facebook's Messenger Platform Payments Thread Settings Documentation

toString

public String toString()

Overrides:

toString in class Object