Global

Methods

createFormattedTweet(tweet, ap, first) → {boolean}

This can literally handle anything tweet related. Every single tweet is passed through here.

Parameters:

Name	Type	Description
tweet	obj	Tweet Object
ap	boolean	Append tweet instead of prepending it.
first	boolean	Designates a first tweet of the stream.

Source:

• twitter.js, line 468

To Do:

• Make it rely on the tweet.event instead of supplied via stream, Clean-up.

Returns:

Success/Failure

Type

boolean

createNotificationTweet(tweet, div)

Creates a fav/rt/special type of tweet, and prepends onto div.

Parameters:

Name	Type	Description
tweet	obj	Tweet object.
div	string	Div to prepend too.

Source:

• twitter.js, line 433

Returns:

none

decryptConfig(user, dir) → {json}

Decrypts a {string} user's config file in {string} dir.

Parameters:

Name	Type	Description
user	string	Username for cfg file.
dir	string	DIR for passing to loadUser()

Source:

• twitter.js, line 305

Returns:

config, or throws error.

Type

json

del(id)

Attempts to delete a tweet.

Parameters:

Name	Type	Description
id	int	Id of tweet to delete.

Source:

• twitter.js, line 723

Returns:

none

doReply(id, status) → {bool}

Replys to {int} id, with {string} status.

Parameters:

Name	Type	Description
id	int	Twitter ID to reply to.
status	string	Status to post to Twitter.

Source:

• twitter.js, line 118

Returns:

Success/Failure

Type

bool

fav(id)

Attempts to favorite a tweet.

Parameters:

Name	Type	Description
id	int	Id of tweet to favorite.

Source:

• twitter.js, line 631

Returns:

none

getDms()

Get DMs for current user

Source:

• twitter.js, line 254

Returns:

none

getMainUser() → {array}

Get's main user's config file.

Source:

• twitter.js, line 343

Returns:

Type

array

getTwitterUserInfo(user) → {obj}

Looks up {string} user and returns object.

Parameters:

Name	Type	Description
user	string	User to look up.

Source:

• twitter.js, line 322

Returns:

twitter user's api callback.

Type

obj

getUsersImages(div, link)

A special function adapted for geting users images from avail configs in config_dir

Parameters:

Name	Type	Description
div	string	Div to place images in
link	string	I totally forgot.

Source:

• twitter.js, line 272

Returns:

none

initStream()

Starts inital streams

Source:

• twitter.js, line 6

Returns:

none

loadMoreTweets(lastid)

Attempts to get 50 more tweets from the past.

Parameters:

Name	Type	Description
lastid	int	Last ID of tweet to attempt to get 50 more from.

Source:

• twitter.js, line 140

Returns:

none

loadUser(user, dir) → {string}

Return raw {string} user config in {string} dir.

Parameters:

Name	Type	Description
user	string	Users name for cfg
dir	string	DIR for CFG files.

Source:

• twitter.js, line 370

Returns:

config

Type

string

logout()

Logs current user out, and terminates Stream(s)

Source:

• twitter.js, line 100

Returns:

none

parseTwitterError(err)

"Nicely" displays twitter errors onto client.

Parameters:

Name	Type	Description
err	string/obj	Twitter err obj, or err string.

Source:

• twitter.js, line 607

Returns:

none

postStatus(status) → {bool}

Posts stand-alone status to twitter, with {string} text.

Parameters:

Name	Type	Description
status	string	Status to send too twitter

Source:

• twitter.js, line 79

Returns:

Success/Failure.

Type

bool

postStatusWithMedia(status, file)

Posts a status with an image to twitter.

Parameters:

Name	Type	Description
status	string	Status to post with file.
file	string	Absolute path to file to upload with status.

Source:

• twitter.js, line 678

Returns:

none

postTwitterSuccess(message)

"Nicely" displays twitter success, or anything really.

Parameters:

Name	Type	Description
message	string	Success Message.

Source:

• twitter.js, line 621

Returns:

none

processTweetLinks(text) → {string}

Processes Twitter links, along with regular ones.

Parameters:

Name	Type	Description
text	string	Text to process.

Source:

• twitter.js, line 235

Returns:

Processed Text.

Type

string

relative_time(time) → {string}

Get relative time to a tweets post.

Parameters:

Name	Type	Description
time	string	Twitter formatted Time.

Source:

• twitter.js, line 571

Returns:

time

Type

string

reload(doReconnect)

Starts main user stream

Parameters:

Name	Type	Description
doReconnect	bool	Restart the stream.

Source:

• twitter.js, line 193

Returns:

none

requestPin(user)

Requests pin from Twitter.

Parameters:

Name	Type	Description
user	string	Username to fill in Twitter Username feild.

Source:

• twitter.js, line 162

Returns:

none

rt(id)

Attempts to retweet a tweet.

Parameters:

Name	Type	Description
id	int	Id of tweet to RT.

Source:

• twitter.js, line 654

Returns:

none

runThroughFilter(obj) → {bool}

Processes {obj} obj, and filters out wanted/unwanted tweets

Parameters:

Name	Type	Description
obj	obj	Tweet object

Source:

• twitter.js, line 395

Returns:

Use/Ignore

Type

bool

setMain(user)

Set {string} user, as the main user in main.json

Parameters:

Name	Type	Description
user	string	User to set as main.

Source:

• twitter.js, line 384

Returns:

none

userExists(user) → {bool}

Check if {string} user exists in config_dir

Parameters:

Name	Type	Description
user	string	User to see if cfg exists.

Source:

• twitter.js, line 357

Returns:

Success/Failure

Type

bool