me.timothy.bots

Class Bot

java.lang.Object

me.timothy.bots.Bot

public class Bot
extends java.lang.Object

Handles the functions of the bot (such as replying to comments, checking if a comment summons the bot, etc) but does not contain the connecting logic (looping through each comment that has to be checked and checking it, for example).

This class does NOT ever sleep, so you may run into API restrictions.

Author:

Timothy

Constructor Summary

Constructors

Constructor and Description
Bot(java.lang.String subreddit) Creates the bot for the specified subreddit.

Method Summary

Modifier and Type	Method and Description
me.timothy.jreddit.info.Listing	getRecentComments() Returns a list of recent comments that might need to be scanned.
me.timothy.jreddit.info.Listing	getRecentSubmissions() Returns any new submissions.
me.timothy.jreddit.info.Listing	getUnreadMessages() Returns any new messages.
me.timothy.jreddit.User	getUser() Gets the user.
boolean	loginReddit(java.lang.String username, java.lang.String password, java.lang.String appClientID, java.lang.String appClientSecret) Logs in to reddit.
boolean	respondTo(me.timothy.jreddit.info.Thing replyable, java.lang.String message) Responds to the specified replyable with the specified message.
me.timothy.jreddit.info.Errorable	sendPM(java.lang.String to, java.lang.String title, java.lang.String message) Sends a personal message
boolean	setReadMessage(java.lang.String ids) Marks the specified messages as read.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bot

public Bot(java.lang.String subreddit)

Creates the bot for the specified subreddit.

Parameters:

subreddit - the subreddit to scan

Method Detail

loginReddit

public boolean loginReddit(java.lang.String username,
                           java.lang.String password,
                           java.lang.String appClientID,
                           java.lang.String appClientSecret)
                    throws java.io.IOException,
                           org.json.simple.parser.ParseException

Logs in to reddit. Upon failure use getLastException to see the issue.

Parameters:

username - Username of the reddit account

password - Password of the reddit account

Returns:

true on success, false on failure

Throws:

org.json.simple.parser.ParseException - if the response from reddit is unparsable

java.io.IOException - if an i/o exception occurs

getRecentComments

public me.timothy.jreddit.info.Listing getRecentComments()
                                                  throws java.lang.IllegalStateException,
                                                         java.io.IOException,
                                                         org.json.simple.parser.ParseException

Returns a list of recent comments that might need to be scanned.

Returns:

a list of recent comments

Throws:

java.lang.IllegalStateException - if the user is null

org.json.simple.parser.ParseException - if the response from reddit is unparsable

java.io.IOException - if an i/o exception occurs

getRecentSubmissions

public me.timothy.jreddit.info.Listing getRecentSubmissions()
                                                     throws java.lang.IllegalStateException,
                                                            java.io.IOException,
                                                            org.json.simple.parser.ParseException

Returns any new submissions.

Returns:

new submissions, or null if an error occurs

Throws:

org.json.simple.parser.ParseException - if the response from reddit is unparsable

java.io.IOException - if an i/o exception occurs

java.lang.IllegalStateException

getUnreadMessages

public me.timothy.jreddit.info.Listing getUnreadMessages()
                                                  throws java.io.IOException,
                                                         org.json.simple.parser.ParseException

Returns any new messages.

Returns:

new messages, or null if an error occurs

Throws:

org.json.simple.parser.ParseException - if the response from reddit is unparsable

java.io.IOException - if an i/o exception occurs

respondTo

public boolean respondTo(me.timothy.jreddit.info.Thing replyable,
                         java.lang.String message)
                  throws java.lang.IllegalStateException,
                         java.io.IOException,
                         org.json.simple.parser.ParseException

Responds to the specified replyable with the specified message.

Parameters:

replyable - the thing to reply to

message - the message

Returns:

successful as we can be. returns true if we get TOO_OLD

Throws:

java.lang.IllegalStateException - the illegal state exception

org.json.simple.parser.ParseException - if the response from reddit is unparsable

java.io.IOException - if an i/o exception occurs

sendPM

public me.timothy.jreddit.info.Errorable sendPM(java.lang.String to,
                                                java.lang.String title,
                                                java.lang.String message)
                                         throws java.io.IOException,
                                                org.json.simple.parser.ParseException

Sends a personal message

Parameters:

to - who to send the message to

title - the title of the message

message - the text of the message

Returns:

if there are any errors

Throws:

org.json.simple.parser.ParseException

java.io.IOException

setReadMessage

public boolean setReadMessage(java.lang.String ids)
                       throws java.lang.IllegalStateException,
                              java.io.IOException,
                              org.json.simple.parser.ParseException

Marks the specified messages as read.

Parameters:

ids - the messages

Returns:

if the message was probably marked as read

Throws:

java.lang.IllegalStateException - if rest client or user is null

org.json.simple.parser.ParseException - if the response from reddit is unparsable

java.io.IOException - if an i/o exception occurs

getUser

public me.timothy.jreddit.User getUser()

Gets the user.

Returns:

What user this buot is using