Class: Weibo2::Interface::Comments

Inherits:
Base
  • Object
show all
Defined in:
lib/weibo2/interface/comments.rb

Overview

Comments API

See Also:

Instance Method Summary collapse

Methods inherited from Base

#get, #initialize, #post, #request

Constructor Details

This class inherits a constructor from Weibo2::Interface::Base

Instance Method Details

#by_me(opts = {}) ⇒ Object

获取当前登录用户所发出的评论列表

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :since_id (int64) —

    若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0

  • :max_id (int64) —

    若指定此参数，则返回ID小于或等于max_id的评论，默认为0

  • :count (int) —

    单页返回的记录条数，默认为50

  • :page (int) —

    返回结果的页码，默认为1

  • :filter_by_source (int) —

    来源筛选类型，0：全部、1：来自微博的评论、2：来自微群的评论，默认为0

See Also:



35
36
37
 
# File 'lib/weibo2/interface/comments.rb', line 35

def by_me(opts={})
  get 'comments/by_me.json', :params => opts
end

#create(comment, id) ⇒ Object

对一条微博进行评论

Parameters:

  • comment (String) —

    评论内容，内容不超过140个汉字

  • id (int64) —

    需要评论的微博ID

  • opts (Hash)

See Also:



103
104
105
 
# File 'lib/weibo2/interface/comments.rb', line 103

def create(comment, id)
  post 'comments/create.json', :body => {:comment => comment, :id => id}
end

#destroy(cid) ⇒ Object

no test 删除一条评论

Parameters:

  • cid (int64) —

    要删除的评论ID，只能删除登录用户自己发布的评论

See Also:



113
114
115
 
# File 'lib/weibo2/interface/comments.rb', line 113

def destroy(cid)
  post 'comments/destroy.json', :body => {:cid => cid}
end

#destroy_batch(cids) ⇒ Object

根据评论ID批量删除评论

Parameters:

  • cids (String) —

    需要删除的评论ID，用半角逗号隔开，最多20个

See Also:



122
123
124
 
# File 'lib/weibo2/interface/comments.rb', line 122

def destroy_batch(cids)
  post 'comments/destroy_batch.json', :body => {:cids => cids}
end

#mentions(opts = {}) ⇒ Object

获取最新的提到当前登录用户的评论，即@我的评论

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :since_id (int64) —

    若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0

  • :max_id (int64) —

    若指定此参数，则返回ID小于或等于max_id的评论，默认为0

  • :count (int) —

    单页返回的记录条数，默认为50

  • :page (int) —

    返回结果的页码，默认为1

  • :filter_by_author (int) —

    作者筛选类型，0：全部、1：我关注的人、2：陌生人，默认为0

  • :filter_by_source (int) —

    来源筛选类型，0：全部、1：来自微博的评论、2：来自微群的评论，默认为0

See Also:



78
79
80
 
# File 'lib/weibo2/interface/comments.rb', line 78

def mentions(opts={})
  get 'comments/mentions.json', :params => opts
end

#reply(cid, id, comment, opts = {}) ⇒ Object

no test 回复一条评论

Parameters:

  • cid (int64) —

    需要回复的评论ID

  • id (int64) —

    需要评论的微博ID

  • comment (String) —

    回复评论内容，内容不超过140个汉字

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :without_mention (int) —

    回复中是否自动加入“回复@用户名”，0：是、1：否，默认为0

  • :comment_on (int) —

    当评论转发微博时，是否评论给原微博，0：否、1：是，默认为0

See Also:



137
138
139
 
# File 'lib/weibo2/interface/comments.rb', line 137

def reply(cid, id, comment, opts={})
  post 'comments/reply.json', :body => {:cid => cid, :id => id, :comment => comment}.merge(opts)
end

#show(id, opts = {}) ⇒ Object

根据微博ID返回某条微博的评论列表

Parameters:

  • id (int64) —

    需要查询的微博ID

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :since_id (int64) —

    若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0

  • :max_id (int64) —

    若指定此参数，则返回ID小于或等于max_id的评论，默认为0

  • :count (int) —

    单页返回的记录条数，默认为50

  • :page (int) —

    返回结果的页码，默认为1

  • :filter_by_author (int) —

    作者筛选类型，0：全部、1：我关注的人、2：陌生人，默认为0

See Also:



21
22
23
 
# File 'lib/weibo2/interface/comments.rb', line 21

def show(id, opts={})
  get 'comments/show.json', :params => {:id => id}.merge(opts)
end

#show_batch(cids) ⇒ Object

根据评论ID批量返回评论信息

Parameters:

  • cids (String) —

    需要查询的批量评论ID，用半角逗号分隔，最大50

See Also:



87
88
89
 
# File 'lib/weibo2/interface/comments.rb', line 87

def show_batch(cids)
  get 'comments/show_batch.json', :params => {:cids => cids}
end

#timeline(opts = {}) ⇒ Object

获取当前登录用户的最新评论包括接收到的与发出的

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :since_id (int64) —

    若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0

  • :max_id (int64) —

    若指定此参数，则返回ID小于或等于max_id的评论，默认为0

  • :count (int) —

    单页返回的记录条数，默认为50

  • :page (int) —

    返回结果的页码，默认为1

See Also:



63
64
65
 
# File 'lib/weibo2/interface/comments.rb', line 63

def timeline(opts={})
  get 'comments/timeline.json', :params => opts
end

#to_me(opts = {}) ⇒ Object

获取当前登录用户所接收到的评论列表

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :since_id (int64) —

    若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0

  • :max_id (int64) —

    若指定此参数，则返回ID小于或等于max_id的评论，默认为0

  • :count (int) —

    单页返回的记录条数，默认为50

  • :page (int) —

    返回结果的页码，默认为1

  • :filter_by_author (int) —

    作者筛选类型，0：全部、1：我关注的人、2：陌生人，默认为0

  • :filter_by_source (int) —

    来源筛选类型，0：全部、1：来自微博的评论、2：来自微群的评论，默认为0

See Also:



50
51
52
 
# File 'lib/weibo2/interface/comments.rb', line 50

def to_me(opts={})
  get 'comments/to_me.json', :params => opts
end