3
0
mirror of https://github.com/reality/dbot.git synced 2024-11-24 12:59:34 +01:00
dbot/modules/reddit/README.md
reality 1cc99d02e1 ]
2013-05-13 18:21:50 +00:00

859 B

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

Posts a summary when either a subreddit, a post or a comment is linked in a channel.