Class: Serel::Comment

Inherits:
Base
  • Object
show all
Defined in:
lib/serel/comment.rb

Overview

The Comment class represents a Stack Exchange comment object.

Finding Comments

Comments can be retrieved using any of the standard finder methods: all, get & find.

all

Serel::Comment.all

It is recommended that you don’t use this method, since most of the time it is overkill. Automatically paginating through all the comments on a site, even 100 comments at a time, will take a long time and a lot of requests. It is almost certainly better to use one of the other finder methods, but this is here for the sake of completion. If you need to access every comment, the data dump and data explorer are your friends.

find

Serel::Comment.find(id)

Retrieves a comment or comments by ID.

get

Serel::Comment.get

Retrieves a page of comment results, applying any scopes that have previously been defined.

Answer#comments

Serel::Answer.find(id).comments.get

Retrieves a page of comments on the specified answer.

Post#comments

Serel::Post.find(id).comments.get

Retrieves a page of comments on the specified post.

Question#comments

Serel::Question.find(id).comments.get

Retrieves a page of comments on the specified question.

User#comments

Serel::User.find(id).comments.get
Serel::User.find(id).comments(other_id).get

Retrieves a page of comments by the specified user. If the optional other_id parameter is passed then only comments in reply to other_id are included.

User#mentioned

Serel::User.find(id).mentioned.get

Retrieves a page of comments mentioning the specified user.

Instance Method Summary collapse

Methods inherited from Base

#[], #[]=, #all, associations, attribute, config, #find, finder_methods, #get, #initialize, #inspect, #meth, method_missing, #network, network_wide, new_relation, request, respond_to?, #type, with_ids

Constructor Details

This class inherits a constructor from Serel::Base

Instance Method Details

#post ⇒ Serel::Post

Retrieves the post that this comment is on.

Note that this returns the post, rather than returning a Response wrapped array.

Returns:



72
73
74
 
# File 'lib/serel/comment.rb', line 72

def post
  type(:post, :singular).url("posts/#{post_id}").get
end