org.botlibre.sense.twitter

Class Twitter

java.lang.Object

org.botlibre.sense.BasicSense

org.botlibre.sense.twitter.Twitter

All Implemented Interfaces:

Sense

Direct Known Subclasses:

TwitterDirectMessaging

public class Twitter
extends BasicSense

Enables receiving a sending messages through Twitter.

Field Summary

Fields

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

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
Twitter()
Twitter(boolean enabled)

Method Summary

Modifier and Type	Method and Description
void	addFriend(java.lang.String friend) Add the follower.
twitter4j.auth.RequestToken	authorizeAccount() Authorise a new account to be accessible by Bot.
void	authorizeComplete() 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	checkAutoFollowSearch(int friendCount) Check search keywords.
void	checkAutoTweet() Auto tweet.
void	checkFollowers() Check followers.
boolean	checkFriendship(long friendId, boolean welcomeOnly)
void	checkLearning() Learn from the profiles posts.
void	checkMentions() Check messages to this user.
void	checkProfile() Check profile for messages.
void	checkRSS() Check RSS feed.
void	checkSearch() Check search keywords.
void	checkStatus() Check status.
void	checkTrends() Check trends.
void	connect()
java.lang.String	format(java.lang.String text)
boolean	getAutoFollow()
boolean	getAutoFollowFriendsFollowers()
boolean	getAutoFollowFriendsFriends()
java.util.List<java.lang.String>	getAutoFollowKeywords()
java.util.List<java.lang.String>	getAutoFollowSearch()
boolean	getAutoTweet()
int	getAutoTweetHours()
java.util.List<Vertex>	getAutoTweets(Network network)
boolean	getCheckTrends()
twitter4j.Twitter	getConnection()
java.util.List<java.lang.String>	getFollowers() Return the list of followers names.
int	getFollowersCount() Return the total number of followers.
boolean	getFollowMessages()
java.util.List<java.lang.String>	getFriends() Return the list of friends names.
int	getFriendsCount() Return the total number of friends.
boolean	getIgnoreReplies()
boolean	getLearn()
boolean	getLearnFromSelf()
boolean	getListenStatus()
int	getMaxFeed()
int	getMaxFriends()
int	getMaxSearch()
int	getMaxStatus()
java.lang.String	getOauthKey()
java.lang.String	getOauthSecret()
boolean	getProcessStatus()
boolean	getReplyToMentions()
boolean	getReplyToMessages()
java.util.List<java.lang.String>	getRetweet()
int	getRetweets()
java.util.List<java.lang.String>	getRssKeywords()
java.util.List<java.lang.String>	getStatusKeywords()
java.util.List<java.lang.String>	getTimeline() Return the time-line.
java.lang.String	getToken()
java.lang.String	getTokenSecret()
boolean	getTweetChats()
java.util.List<java.lang.String>	getTweetRSS()
int	getTweets()
java.util.List<java.lang.String>	getTweetSearch()
int	getTweetsProcessed()
java.lang.String	getUserName()
java.lang.String	getWelcomeMessage()
void	initProperties() Load settings.
void	input(java.lang.Object input, Network network) Process the email message.
void	inputSentence(java.lang.String text, java.lang.String userName, java.lang.String targetUserName, twitter4j.Status status, Network network) Process the text sentence.
void	learnSearch(java.lang.String tweetSearch, int maxSearch, boolean processTweets, boolean processReplies) Learn responses from the tweet search.
void	learnTweet(twitter4j.Status tweet, boolean processTweets, boolean processReplies, Network memory)
void	log(twitter4j.TwitterException exception)
void	message(Vertex source, Vertex replyUser, Vertex text) Self API Send a message to the user.
void	migrateProperties() Migrate to new properties system.
void	output(Vertex output) Output the status or direct message reply.
void	outputTweet(java.lang.String tweet) Output the tweet if twitter is connected.
void	removeFriend(java.lang.String friend) Add the follower.
void	retweet(twitter4j.Status tweet) Retweet the tweet.
void	saveProperties(java.util.List<java.lang.String> autoTweets)
void	sendMessage(java.lang.String text, java.lang.String replyUser) Send a message to the user.
void	sendMessage(Vertex source, Vertex text, Vertex replyUser) Self API Send a message to the user.
void	setAutoFollow(boolean autoFollow)
void	setAutoFollowFriendsFollowers(boolean autoFollowFriendsFollowers)
void	setAutoFollowFriendsFriends(boolean autoFollowFriendsFriends)
void	setAutoFollowKeywords(java.util.List<java.lang.String> autoFollowKeywords)
void	setAutoFollowSearch(java.util.List<java.lang.String> autoFollowSearch)
void	setAutoTweet(boolean autoTweet)
void	setAutoTweetHours(int autoTweetHours)
void	setCheckTrends(boolean checkTrends)
void	setConnection(twitter4j.Twitter connection)
void	setFollowMessages(boolean followMessages)
void	setIgnoreReplies(boolean ignoreReplies)
void	setLearn(boolean learn)
void	setLearnFromSelf(boolean learnFromSelf)
void	setListenStatus(boolean listenStatus)
void	setMaxFeed(int maxFeed)
void	setMaxFriends(int maxFriends)
void	setMaxSearch(int maxSearch)
void	setMaxStatus(int maxStatus)
void	setOauthKey(java.lang.String oauthKey)
void	setOauthSecret(java.lang.String oauthSecret)
void	setProcessStatus(boolean processStatus)
void	setReplyToMentions(boolean replyToMentions)
void	setReplyToMessages(boolean replyToMessages)
void	setRetweet(java.util.List<java.lang.String> retweet)
void	setRetweets(int retweets)
void	setRssKeywords(java.util.List<java.lang.String> rssKeywords)
void	setStatusKeywords(java.util.List<java.lang.String> statusKeywords)
void	setToken(java.lang.String token)
void	setTokenSecret(java.lang.String tokenSecret)
void	setTweetChats(boolean tweetChats)
void	setTweetRSS(java.util.List<java.lang.String> tweetRSS)
void	setTweets(int tweets)
void	setTweetSearch(java.util.List<java.lang.String> tweetSearch)
void	setTweetsProcessed(int tweetsProcessed)
void	setUserName(java.lang.String userName)
void	setWelcomeMessage(java.lang.String welcomeMessage)
Vertex	trend(Network network)
void	tweet(java.lang.String html, java.lang.Long reply) Tweet.
void	tweet(Vertex source, Vertex sentence)

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

TREND_CHECK

public static int TREND_CHECK

MAX_LOOKUP

public static int MAX_LOOKUP

oauthKey

public static java.lang.String oauthKey

oauthSecret

public static java.lang.String oauthSecret

Constructor Detail

Twitter

public Twitter(boolean enabled)

Twitter

public Twitter()

Method Detail

getListenStatus

public boolean getListenStatus()

setListenStatus

public void setListenStatus(boolean listenStatus)

getTweets

public int getTweets()

setTweets

public void setTweets(int tweets)

getTweetsProcessed

public int getTweetsProcessed()

setTweetsProcessed

public void setTweetsProcessed(int tweetsProcessed)

getRetweets

public int getRetweets()

setRetweets

public void setRetweets(int retweets)

getWelcomeMessage

public java.lang.String getWelcomeMessage()

setWelcomeMessage

public void setWelcomeMessage(java.lang.String welcomeMessage)

getRssKeywords

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

setRssKeywords

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

getMaxSearch

public int getMaxSearch()

setMaxSearch

public void setMaxSearch(int maxSearch)

getAutoFollowSearch

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

setAutoFollowSearch

public void setAutoFollowSearch(java.util.List<java.lang.String> autoFollowSearch)

getAutoFollowFriendsFriends

public boolean getAutoFollowFriendsFriends()

setAutoFollowFriendsFriends

public void setAutoFollowFriendsFriends(boolean autoFollowFriendsFriends)

getAutoFollowFriendsFollowers

public boolean getAutoFollowFriendsFollowers()

setAutoFollowFriendsFollowers

public void setAutoFollowFriendsFollowers(boolean autoFollowFriendsFollowers)

getMaxFeed

public int getMaxFeed()

setMaxFeed

public void setMaxFeed(int maxFeed)

getAutoTweet

public boolean getAutoTweet()

setAutoTweet

public void setAutoTweet(boolean autoTweet)

getAutoTweetHours

public int getAutoTweetHours()

setAutoTweetHours

public void setAutoTweetHours(int autoTweetHours)

getAutoTweets

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

getIgnoreReplies

public boolean getIgnoreReplies()

setIgnoreReplies

public void setIgnoreReplies(boolean ignoreReplies)

getStatusKeywords

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

setStatusKeywords

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

getAutoFollowKeywords

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

setAutoFollowKeywords

public void setAutoFollowKeywords(java.util.List<java.lang.String> autoFollowKeywords)

authorizeAccount

public twitter4j.auth.RequestToken authorizeAccount()
                                             throws twitter4j.TwitterException

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

Throws:

twitter4j.TwitterException

authorizeComplete

public void authorizeComplete()
                       throws twitter4j.TwitterException

Authorise a new account to be accessible by Bot.

Throws:

twitter4j.TwitterException

authorizeComplete

public void authorizeComplete(java.lang.String pin)
                       throws twitter4j.TwitterException

Authorise a new account to be accessible by Bot.

Throws:

twitter4j.TwitterException

awake

public void awake()

Start sensing.

Specified by:

awake in interface Sense

Overrides:

awake in class BasicSense

migrateProperties

public void migrateProperties()

Migrate to new properties system.

Specified by:

migrateProperties in interface Sense

Overrides:

migrateProperties in class BasicSense

initProperties

public void initProperties()

Load settings.

saveProperties

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

connect

public void connect()
             throws twitter4j.TwitterException

Throws:

twitter4j.TwitterException

checkProfile

public void checkProfile()

Check profile for messages.

addFriend

public void addFriend(java.lang.String friend)

Add the follower.

removeFriend

public void removeFriend(java.lang.String friend)

Add the follower.

checkStatus

public void checkStatus()

Check status.

learnSearch

public void learnSearch(java.lang.String tweetSearch,
                        int maxSearch,
                        boolean processTweets,
                        boolean processReplies)

Learn responses from the tweet search.

checkLearning

public void checkLearning()

Learn from the profiles posts.

learnTweet

public void learnTweet(twitter4j.Status tweet,
                       boolean processTweets,
                       boolean processReplies,
                       Network memory)
                throws java.lang.Exception

Throws:

java.lang.Exception

checkMentions

public void checkMentions()

Check messages to this user.

checkSearch

public void checkSearch()

Check search keywords.

checkAutoFollowSearch

public void checkAutoFollowSearch(int friendCount)

Check search keywords.

checkRSS

public void checkRSS()

Check RSS feed.

checkAutoTweet

public void checkAutoTweet()

Auto tweet.

getFollowers

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

Return the list of followers names.

getTimeline

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

Return the time-line.

getFriendsCount

public int getFriendsCount()

Return the total number of friends.

getFollowersCount

public int getFollowersCount()

Return the total number of followers.

getFriends

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

Return the list of friends names.

checkFollowers

public void checkFollowers()

Check followers.

checkFriendship

public boolean checkFriendship(long friendId,
                               boolean welcomeOnly)
                        throws twitter4j.TwitterException

Throws:

twitter4j.TwitterException

log

public void log(twitter4j.TwitterException exception)

checkTrends

public void checkTrends()

Check trends.

tweet

public void tweet(java.lang.String html,
                  java.lang.Long reply)

Tweet.

format

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

sendMessage

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

Send a message to the user.

retweet

public void retweet(twitter4j.Status tweet)

Retweet the tweet.

outputTweet

public void outputTweet(java.lang.String tweet)

Output the tweet if twitter is connected.

input

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

Process the email message.

Specified by:

input in interface Sense

Overrides:

input in class BasicSense

output

public void output(Vertex output)

Output the status 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,
                          twitter4j.Status status,
                          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)

getTokenSecret

public java.lang.String getTokenSecret()

setTokenSecret

public void setTokenSecret(java.lang.String tokenSecret)

getToken

public java.lang.String getToken()

setToken

public void setToken(java.lang.String token)

getConnection

public twitter4j.Twitter getConnection()
                                throws twitter4j.TwitterException

Throws:

twitter4j.TwitterException

setConnection

public void setConnection(twitter4j.Twitter connection)

getAutoFollow

public boolean getAutoFollow()

setAutoFollow

public void setAutoFollow(boolean autoFollow)

getMaxFriends

public int getMaxFriends()

setMaxFriends

public void setMaxFriends(int maxFriends)

getLearn

public boolean getLearn()

setLearn

public void setLearn(boolean learn)

getLearnFromSelf

public boolean getLearnFromSelf()

setLearnFromSelf

public void setLearnFromSelf(boolean learnFromSelf)

getProcessStatus

public boolean getProcessStatus()

setProcessStatus

public void setProcessStatus(boolean processStatus)

getTweetChats

public boolean getTweetChats()

getReplyToMentions

public boolean getReplyToMentions()

getReplyToMessages

public boolean getReplyToMessages()

setTweetChats

public void setTweetChats(boolean tweetChats)

setReplyToMentions

public void setReplyToMentions(boolean replyToMentions)

setReplyToMessages

public void setReplyToMessages(boolean replyToMessages)

getRetweet

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

setRetweet

public void setRetweet(java.util.List<java.lang.String> retweet)

getTweetRSS

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

setTweetRSS

public void setTweetRSS(java.util.List<java.lang.String> tweetRSS)

getCheckTrends

public boolean getCheckTrends()

setCheckTrends

public void setCheckTrends(boolean checkTrends)

getTweetSearch

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

setTweetSearch

public void setTweetSearch(java.util.List<java.lang.String> tweetSearch)

getFollowMessages

public boolean getFollowMessages()

setFollowMessages

public void setFollowMessages(boolean followMessages)

getMaxStatus

public int getMaxStatus()

setMaxStatus

public void setMaxStatus(int maxStatus)

tweet

public void tweet(Vertex source,
                  Vertex sentence)

message

public void message(Vertex source,
                    Vertex replyUser,
                    Vertex text)

Self API Send a message to the user.

sendMessage

public void sendMessage(Vertex source,
                        Vertex text,
                        Vertex replyUser)

Self API Send a message to the user.

trend

public Vertex trend(Network network)
             throws twitter4j.TwitterException

Throws:

twitter4j.TwitterException