GitHub/dbot
3
0
Fork 1
mirror of https://github.com/reality/dbot.git synced 2024-11-23 20:39:25 +01:00
Code Issues Projects Releases Wiki Activity

]

Browse Source
This commit is contained in:
reality 2013-05-13 18:21:50 +00:00
parent 91f2730785
commit 1cc99d02e1
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
modules/reddit/README.md Normal file
View File

@ -0,0 +1,29 @@
## Reddit
Various Reddit functionality
### Description
This module provides Reddit related functionality, which is currently limited to
reading various links, but will be expanded in future to include stuff like
monitoring posts and creating its own.
### API
#### getSubredditInfo(name, callback)
Get information about a subreddit from the Reddit API. Callback takes one
argument, the data returned from the API.
#### getPostInfo(name, callback)
Get information about a post from the Reddit API. Callback takes one argument,
the data returned from the API about the post.
#### getCommentInfo(post, name, callback)
Get information about a particular comment in a particular post. Callback takes
one argument, information about the given comment.
### Hooks
#### link
Posts a summary when either a subreddit, a post or a comment is linked in a
channel.