co.aurasphere.botmill.fb.model.userprofile

Class FacebookUserProfile

java.lang.Object

co.aurasphere.botmill.fb.model.userprofile.FacebookUserProfile

All Implemented Interfaces:

Serializable

public class FacebookUserProfile
extends Object
implements Serializable

Model for the User Profile API.

The profile API can be used to query more information about the user, and personalize the experience further. This API is only available after the user initiated the conversation by sending a message or by interacting with a Web Plugin.

If the conversation was initiated by using a phone number (customer matching]), you will only be able to use this API after the user replied to your message.

The information at this API is only available after a person has sent a message to your bot or clicked the "Send to Messenger" plugin. If you call the API before these actions, then you will receive an empty result. You will also receive an empty result if a person has revoked platform permissions on Facebook.

Author:

Donato Rimenti

See Also:

Facebook's Messenger User Profile Reference Documentation, Facebook's Messenger Platform Plugin Reference Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FacebookUserProfile()

Method Summary

Methods

Modifier and Type	Method and Description
String	getFirstName() Gets the firstName.
Gender	getGender() Gets the gender.
String	getLastName() Gets the lastName.
String	getLocale() Gets the locale.
String	getProfilePic() Gets the profilePic.
int	getTimezone() Gets the timezone.
boolean	isPaymentEnabled() Checks if is payment enabled.
void	setFirstName(String firstName) Sets the firstName.
void	setGender(Gender gender) Sets the gender.
void	setLastName(String lastName) Sets the lastName.
void	setLocale(String locale) Sets the locale.
void	setPaymentEnabled(boolean isPaymentEnabled) Sets the isPaymentEnabled.
void	setProfilePic(String profilePic) Sets the profilePic.
void	setTimezone(int timezone) Sets the timezone.

Methods inherited from class java.lang.Object

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

Constructor Detail

FacebookUserProfile

public FacebookUserProfile()

Method Detail

getFirstName

public String getFirstName()

Gets the firstName.

Returns:

the firstName.

setFirstName

public void setFirstName(String firstName)

Sets the firstName.

Parameters:

firstName - the firstName to set.

getLastName

public String getLastName()

Gets the lastName.

Returns:

the lastName.

setLastName

public void setLastName(String lastName)

Sets the lastName.

Parameters:

lastName - the lastName to set.

getProfilePic

public String getProfilePic()

Gets the profilePic.

Returns:

the profilePic.

setProfilePic

public void setProfilePic(String profilePic)

Sets the profilePic.

Parameters:

profilePic - the profilePic to set.

getLocale

public String getLocale()

Gets the locale.

Returns:

the locale.

setLocale

public void setLocale(String locale)

Sets the locale.

Parameters:

locale - the locale to set.

getTimezone

public int getTimezone()

Gets the timezone.

Returns:

the timezone.

setTimezone

public void setTimezone(int timezone)

Sets the timezone.

Parameters:

timezone - the timezone to set.

getGender

public Gender getGender()

Gets the gender.

Returns:

the gender.

setGender

public void setGender(Gender gender)

Sets the gender.

Parameters:

gender - the gender to set.

isPaymentEnabled

public boolean isPaymentEnabled()

Checks if is payment enabled.

Returns:

the {#isPaymentEnabled}.

setPaymentEnabled

public void setPaymentEnabled(boolean isPaymentEnabled)

Sets the isPaymentEnabled.

Parameters:

isPaymentEnabled - the isPaymentEnabled to set.