org.botlibre.sense.facebook

Class Facebook

java.lang.Object

org.botlibre.sense.BasicSense

org.botlibre.sense.facebook.Facebook

All Implemented Interfaces:

Sense

Direct Known Subclasses:

FacebookMessaging

public class Facebook
extends BasicSense

Enables receiving a sending messages through Facebook.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	appOauthKey
java.lang.String	appOauthSecret
static int	MAX_LOOKUP
static java.lang.String	oauthKey
static java.lang.String	oauthSecret

Fields inherited from class org.botlibre.sense.BasicSense

conversations, DAY, DEFAULT_SPEAKER, engaged, HOUR, MAX_FILE_SIZE, MINUTE, RETRY

Constructor Summary

Constructors

Constructor and Description
Facebook()
Facebook(boolean enabled)

Method Summary

Modifier and Type	Method and Description
java.lang.String	authorizeAccount(java.lang.String callbackURL) Authorise a new account to be accessible by Bot.
void	authorizeComplete(java.lang.String pin) Authorise a new account to be accessible by Bot.
void	awake() Start sensing.
void	checkAutoPost() Auto post.
void	checkFriends() Check friends.
void	checkNewsFeed() Check news feed posts.
void	checkProfile() Check profile for messages.
void	checkRSS() Check RSS feed.
void	checkWall() Check wall posts.
void	connect()
void	connectAccount()
java.lang.String	createJSONAttachment(java.lang.String command, java.lang.String id, java.lang.String text) Check the command JSON for a Facebook attachment object to append to a Facebook Messeneger message.
java.lang.String	createJSONQuickReply(java.lang.String command, java.lang.String id, java.lang.String text) Check the command JSON for a Facebook attachment object to append to a Facebook Messeneger message.
java.lang.String	format(java.lang.String text) Prepare and format the text for Facebook.
java.lang.String	getAppOauthKey()
java.lang.String	getAppOauthSecret()
boolean	getAutoFriend()
java.util.List<java.lang.String>	getAutoFriendKeywords()
boolean	getAutoPost()
int	getAutoPostHours()
java.util.List<Vertex>	getAutoPosts(Network network)
java.lang.String	getButtonType()
facebook4j.Facebook	getConnection()
boolean	getFacebookMessenger()
java.lang.String	getFacebookMessengerAccessToken()
java.util.List<java.lang.String>	getFriends() Return the list of friends names.
java.lang.String	getGetStartedButton()
java.lang.String	getGreetingText()
boolean	getLikeAllPosts()
java.util.List<java.lang.String>	getLikeKeywords()
int	getLikes()
int	getMaxFeed()
int	getMaxFriends()
int	getMaxLike()
int	getMaxPost()
int	getMessagesProcessed()
java.util.List<java.lang.String>	getNewsFeedKeywords()
java.lang.String	getOauthKey()
java.lang.String	getOauthSecret()
java.lang.String	getPage()
java.lang.String	getPageId()
java.util.List<java.lang.String>	getPages()
java.lang.String	getPersistentMenu()
java.util.List<java.lang.String>	getPostKeywords()
java.util.List<java.lang.String>	getPostRSS()
int	getPosts()
int	getPostsProcessed()
boolean	getProcessAllNewsFeed()
boolean	getProcessAllPosts()
boolean	getProcessNewsFeed()
boolean	getProcessPost()
java.lang.String	getProfileName()
boolean	getReplyToMessages()
java.util.List<java.lang.String>	getRssKeywords()
boolean	getStripButtonText()
java.util.List<java.lang.String>	getTimeline() Return the time-line.
java.lang.String	getToken()
java.util.Date	getTokenExpiry()
boolean	getTrackMessageObjects()
java.lang.String	getUserName()
java.lang.String	getWelcomeMessage()
void	initProperties() Load settings.
void	input(facebook4j.Comment comment, facebook4j.Comment parent, Network network) Process the post comment.
void	input(java.lang.Object input, Network network) Process the post.
void	inputSentence(java.lang.String text, java.lang.String userName, java.lang.String targetUserName, java.lang.String messageId, long time, Network network) Process the text sentence.
boolean	isPage()
void	like(facebook4j.Post post) Like the post.
void	log(facebook4j.FacebookException exception)
void	migrateProperties() Migrate to new properties system.
void	output(Vertex output) Output the post or direct message reply.
void	outputPost(java.lang.String post) Output the post if facebook is connected.
void	post(java.lang.String text, java.lang.String reply) Post.
void	post(Vertex source, Vertex sentence)
void	postComment(Vertex source, Vertex sentence, Vertex postId)
long[]	processComment(facebook4j.Comment comment, facebook4j.Comment parent, Network memory, int count, long max, long last)
void	saveProperties(java.util.List<java.lang.String> autoPosts)
void	sendFacebookMessengerButtonMessage(java.lang.String text, java.lang.String command, java.lang.String replyUser, java.lang.String id) Send a button template message to the user.
void	sendFacebookMessengerMessage(java.lang.String text, java.lang.String replyUser, java.lang.String id) Send a message to the user.
void	sendMessage(java.lang.String text, java.lang.String replyUser, java.lang.String id) Send a message to the user.
void	sendMessage(Vertex source, Vertex message, Vertex conversationId) Send a message to the user.
void	setAppOauthKey(java.lang.String appOauthKey)
void	setAppOauthSecret(java.lang.String appOauthSecret)
void	setAutoFriend(boolean autoFriend)
void	setAutoFriendKeywords(java.util.List<java.lang.String> autoFriendKeywords)
void	setAutoPost(boolean autoPost)
void	setAutoPostHours(int autoPostHours)
void	setButtonType(java.lang.String buttonType)
void	setConnection(facebook4j.Facebook connection)
void	setFacebookMessenger(boolean facebookMessenger)
void	setFacebookMessengerAccessToken(java.lang.String facebookMessengerAccessToken)
void	setGetStartedButton(java.lang.String getStartedButton)
void	setGreetingText(java.lang.String greetingText)
void	setLikeAllPosts(boolean likesAllPosts)
void	setLikeKeywords(java.util.List<java.lang.String> likeKeywords)
void	setLikes(int likes)
void	setMaxFeed(int maxFeed)
void	setMaxFriends(int maxFriends)
void	setMaxLike(int maxLike)
void	setMaxPost(int maxPost)
void	setMessagesProcessed(int messagesProcessed)
void	setNewsFeedKeywords(java.util.List<java.lang.String> newsFeedKeywords)
void	setOauthKey(java.lang.String oauthKey)
void	setOauthSecret(java.lang.String oauthSecret)
void	setPage(java.lang.String page)
void	setPageId(java.lang.String pageId)
void	setPages(java.util.List<java.lang.String> pages)
void	setPersistentMenu(java.lang.String persistentMenu)
void	setPostKeywords(java.util.List<java.lang.String> statusKeywords)
void	setPostRSS(java.util.List<java.lang.String> postRSS)
void	setPosts(int posts)
void	setPostsProcessed(int postsProcessed)
void	setProcessAllNewsFeed(boolean processAllNewsFeed)
void	setProcessAllPosts(boolean processAllPosts)
void	setProcessNewsFeed(boolean processNewsFeed)
void	setProcessPost(boolean processPost)
void	setProfileName(java.lang.String profileName)
void	setReplyToMessages(boolean replyToMessages)
void	setRssKeywords(java.util.List<java.lang.String> rssKeywords)
void	setStripButtonText(boolean stripButtonText)
void	setToken(java.lang.String token)
void	setTrackMessageObjects(boolean trackMessageObjects)
void	setUserName(java.lang.String userName)
void	setWelcomeMessage(java.lang.String welcomeMessage)
void	subscribeToMessenger()
void	updateThreadSettings(java.lang.String persistentMenu, java.lang.String getStartedButton, java.lang.String greetingText) Set the "Persistent Menu" in the page's Facebook Messenger.

Methods inherited from class org.botlibre.sense.BasicSense

addListener, checkEngaged, checkSentence, discover, discoverSentence, getAction, getBot, getEmotionalState, getLanguageState, getListeners, getName, getPrimitive, getResponseListener, getShortTermMemory, initialize, input, isEnabled, log, log, log, notifyExceptionListeners, notifyResponseListener, pool, printInput, removeListener, saveProperties, setAction, setBot, setEmotionalState, setIsEnabled, setLanguageState, setName, setResponseListener, shutdown, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_LOOKUP

public static int MAX_LOOKUP

oauthKey

public static java.lang.String oauthKey

oauthSecret

public static java.lang.String oauthSecret

appOauthKey

public java.lang.String appOauthKey

appOauthSecret

public java.lang.String appOauthSecret

Constructor Detail

Facebook

public Facebook(boolean enabled)

Facebook

public Facebook()

Method Detail

getTrackMessageObjects

public boolean getTrackMessageObjects()

setTrackMessageObjects

public void setTrackMessageObjects(boolean trackMessageObjects)

getAppOauthKey

public java.lang.String getAppOauthKey()

setAppOauthKey

public void setAppOauthKey(java.lang.String appOauthKey)

getAppOauthSecret

public java.lang.String getAppOauthSecret()

setAppOauthSecret

public void setAppOauthSecret(java.lang.String appOauthSecret)

getPages

public java.util.List<java.lang.String> getPages()

setPages

public void setPages(java.util.List<java.lang.String> pages)

getStripButtonText

public boolean getStripButtonText()

setStripButtonText

public void setStripButtonText(boolean stripButtonText)

getButtonType

public java.lang.String getButtonType()

setButtonType

public void setButtonType(java.lang.String buttonType)

getGetStartedButton

public java.lang.String getGetStartedButton()

setGetStartedButton

public void setGetStartedButton(java.lang.String getStartedButton)

getGreetingText

public java.lang.String getGreetingText()

setGreetingText

public void setGreetingText(java.lang.String greetingText)

getPersistentMenu

public java.lang.String getPersistentMenu()

setPersistentMenu

public void setPersistentMenu(java.lang.String persistentMenu)

getPosts

public int getPosts()

setPosts

public void setPosts(int posts)

getPostsProcessed

public int getPostsProcessed()

setPostsProcessed

public void setPostsProcessed(int postsProcessed)

getMessagesProcessed

public int getMessagesProcessed()

setMessagesProcessed

public void setMessagesProcessed(int messagesProcessed)

getLikes

public int getLikes()

setLikes

public void setLikes(int likes)

getPage

public java.lang.String getPage()

getPageId

public java.lang.String getPageId()

setPageId

public void setPageId(java.lang.String pageId)

getProfileName

public java.lang.String getProfileName()

setProfileName

public void setProfileName(java.lang.String profileName)

setPage

public void setPage(java.lang.String page)

getFacebookMessengerAccessToken

public java.lang.String getFacebookMessengerAccessToken()

setFacebookMessengerAccessToken

public void setFacebookMessengerAccessToken(java.lang.String facebookMessengerAccessToken)

getWelcomeMessage

public java.lang.String getWelcomeMessage()

setWelcomeMessage

public void setWelcomeMessage(java.lang.String welcomeMessage)

getProcessAllPosts

public boolean getProcessAllPosts()

setProcessAllPosts

public void setProcessAllPosts(boolean processAllPosts)

getProcessAllNewsFeed

public boolean getProcessAllNewsFeed()

setProcessAllNewsFeed

public void setProcessAllNewsFeed(boolean processAllNewsFeed)

getLikeAllPosts

public boolean getLikeAllPosts()

setLikeAllPosts

public void setLikeAllPosts(boolean likesAllPosts)

getRssKeywords

public java.util.List<java.lang.String> getRssKeywords()

setRssKeywords

public void setRssKeywords(java.util.List<java.lang.String> rssKeywords)

getProcessNewsFeed

public boolean getProcessNewsFeed()

setProcessNewsFeed

public void setProcessNewsFeed(boolean processNewsFeed)

getNewsFeedKeywords

public java.util.List<java.lang.String> getNewsFeedKeywords()

setNewsFeedKeywords

public void setNewsFeedKeywords(java.util.List<java.lang.String> newsFeedKeywords)

getMaxFeed

public int getMaxFeed()

setMaxFeed

public void setMaxFeed(int maxFeed)

getAutoPost

public boolean getAutoPost()

setAutoPost

public void setAutoPost(boolean autoPost)

getAutoPostHours

public int getAutoPostHours()

setAutoPostHours

public void setAutoPostHours(int autoPostHours)

getAutoPosts

public java.util.List<Vertex> getAutoPosts(Network network)

getPostKeywords

public java.util.List<java.lang.String> getPostKeywords()

setPostKeywords

public void setPostKeywords(java.util.List<java.lang.String> statusKeywords)

getAutoFriendKeywords

public java.util.List<java.lang.String> getAutoFriendKeywords()

setAutoFriendKeywords

public void setAutoFriendKeywords(java.util.List<java.lang.String> autoFriendKeywords)

authorizeAccount

public java.lang.String authorizeAccount(java.lang.String callbackURL)
                                  throws facebook4j.FacebookException

Authorise a new account to be accessible by Bot. Return the request token that contains the URL that the user must use to authorise facebook.

Throws:

facebook4j.FacebookException

authorizeComplete

public void authorizeComplete(java.lang.String pin)
                       throws facebook4j.FacebookException

Authorise a new account to be accessible by Bot.

Throws:

facebook4j.FacebookException

awake

public void awake()

Start sensing.

Specified by:

awake in interface Sense

Overrides:

awake in class BasicSense

initProperties

public void initProperties()

Load settings.

migrateProperties

public void migrateProperties()

Migrate to new properties system.

Specified by:

migrateProperties in interface Sense

Overrides:

migrateProperties in class BasicSense

saveProperties

public void saveProperties(java.util.List<java.lang.String> autoPosts)

updateThreadSettings

public void updateThreadSettings(java.lang.String persistentMenu,
                                 java.lang.String getStartedButton,
                                 java.lang.String greetingText)

Set the "Persistent Menu" in the page's Facebook Messenger.

connect

public void connect()
             throws facebook4j.FacebookException

Throws:

facebook4j.FacebookException

connectAccount

public void connectAccount()
                    throws facebook4j.FacebookException

Throws:

facebook4j.FacebookException

subscribeToMessenger

public void subscribeToMessenger()
                          throws facebook4j.FacebookException

Throws:

facebook4j.FacebookException

checkProfile

public void checkProfile()

Check profile for messages.

checkWall

public void checkWall()

Check wall posts.

processComment

public long[] processComment(facebook4j.Comment comment,
                             facebook4j.Comment parent,
                             Network memory,
                             int count,
                             long max,
                             long last)

checkNewsFeed

public void checkNewsFeed()

Check news feed posts.

checkRSS

public void checkRSS()

Check RSS feed.

checkAutoPost

public void checkAutoPost()

Auto post.

isPage

public boolean isPage()

getFriends

public java.util.List<java.lang.String> getFriends()

Return the list of friends names.

getTimeline

public java.util.List<java.lang.String> getTimeline()

Return the time-line.

checkFriends

public void checkFriends()

Check friends.

log

public void log(facebook4j.FacebookException exception)

post

public void post(java.lang.String text,
                 java.lang.String reply)

Post.

format

public java.lang.String format(java.lang.String text)

Prepare and format the text for Facebook.

sendMessage

public void sendMessage(Vertex source,
                        Vertex message,
                        Vertex conversationId)

Send a message to the user.

sendMessage

public void sendMessage(java.lang.String text,
                        java.lang.String replyUser,
                        java.lang.String id)

Send a message to the user.

sendFacebookMessengerMessage

public void sendFacebookMessengerMessage(java.lang.String text,
                                         java.lang.String replyUser,
                                         java.lang.String id)

Send a message to the user.

sendFacebookMessengerButtonMessage

public void sendFacebookMessengerButtonMessage(java.lang.String text,
                                               java.lang.String command,
                                               java.lang.String replyUser,
                                               java.lang.String id)

Send a button template message to the user.

like

public void like(facebook4j.Post post)

Like the post.

outputPost

public void outputPost(java.lang.String post)

Output the post if facebook is connected.

input

public void input(java.lang.Object input,
                  Network network)

Process the post.

Specified by:

input in interface Sense

Overrides:

input in class BasicSense

input

public void input(facebook4j.Comment comment,
                  facebook4j.Comment parent,
                  Network network)

Process the post comment.

output

public void output(Vertex output)

Output the post or direct message reply.

Specified by:

output in interface Sense

Overrides:

output in class BasicSense

getUserName

public java.lang.String getUserName()

setUserName

public void setUserName(java.lang.String userName)

inputSentence

public void inputSentence(java.lang.String text,
                          java.lang.String userName,
                          java.lang.String targetUserName,
                          java.lang.String messageId,
                          long time,
                          Network network)

Process the text sentence.

getOauthKey

public java.lang.String getOauthKey()

setOauthKey

public void setOauthKey(java.lang.String oauthKey)

getOauthSecret

public java.lang.String getOauthSecret()

setOauthSecret

public void setOauthSecret(java.lang.String oauthSecret)

getToken

public java.lang.String getToken()

getTokenExpiry

public java.util.Date getTokenExpiry()

setToken

public void setToken(java.lang.String token)

getConnection

public facebook4j.Facebook getConnection()
                                  throws facebook4j.FacebookException

Throws:

facebook4j.FacebookException

setConnection

public void setConnection(facebook4j.Facebook connection)

getAutoFriend

public boolean getAutoFriend()

setAutoFriend

public void setAutoFriend(boolean autoFriend)

getMaxFriends

public int getMaxFriends()

setMaxFriends

public void setMaxFriends(int maxFriends)

getProcessPost

public boolean getProcessPost()

setProcessPost

public void setProcessPost(boolean processPost)

getReplyToMessages

public boolean getReplyToMessages()

getFacebookMessenger

public boolean getFacebookMessenger()

setFacebookMessenger

public void setFacebookMessenger(boolean facebookMessenger)

setReplyToMessages

public void setReplyToMessages(boolean replyToMessages)

getLikeKeywords

public java.util.List<java.lang.String> getLikeKeywords()

setLikeKeywords

public void setLikeKeywords(java.util.List<java.lang.String> likeKeywords)

getPostRSS

public java.util.List<java.lang.String> getPostRSS()

setPostRSS

public void setPostRSS(java.util.List<java.lang.String> postRSS)

getMaxPost

public int getMaxPost()

setMaxPost

public void setMaxPost(int maxPost)

getMaxLike

public int getMaxLike()

setMaxLike

public void setMaxLike(int maxLike)

post

public void post(Vertex source,
                 Vertex sentence)

postComment

public void postComment(Vertex source,
                        Vertex sentence,
                        Vertex postId)

createJSONAttachment

public java.lang.String createJSONAttachment(java.lang.String command,
                                             java.lang.String id,
                                             java.lang.String text)

Check the command JSON for a Facebook attachment object to append to a Facebook Messeneger message.

createJSONQuickReply

public java.lang.String createJSONQuickReply(java.lang.String command,
                                             java.lang.String id,
                                             java.lang.String text)

Check the command JSON for a Facebook attachment object to append to a Facebook Messeneger message.