Class: Vk::API::Newsfeed::Methods::GetComments

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Newsfeed::Methods::GetComments

Defined in:

lib/vk/api/newsfeed/methods/get_comments.rb

Overview

Returns a list of comments in the current user's newsfeed.

Arguments

• #count ⇒ Integer

  Number of comments to return.

• #end_time ⇒ Integer

  Latest timestamp (in Unix time) of a comment to return.

• #fields ⇒ Array

  Additional fields of and to return.

• #filters ⇒ Array

  Filters to apply:; 'post' — new comments on wall posts; 'photo' — new comments on photos; 'video' — new comments on videos; 'topic' — new comments on discussions; 'note' — new comments on notes;.

• #reposts ⇒ String

  Object ID, comments on repost of which shall be returned, e.g.

• #start_from ⇒ String

  Identificator needed to return the next oage with results.

• #start_time ⇒ Integer

  Earliest timestamp (in Unix time) of a comment to return.

Instance Method Summary

• #initialize(arguments) ⇒ Newsfeed::Methods::GetComments constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Newsfeed::Methods::GetComments

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :count (Integer) —

  Number of comments to return. For auto feed, you can use the 'new_offset' parameter returned by this method.

• :filters (Array) —

  Filters to apply:; 'post' — new comments on wall posts; 'photo' — new comments on photos; 'video' — new comments on videos; 'topic' — new comments on discussions; 'note' — new comments on notes;

• :reposts (String) —

  Object ID, comments on repost of which shall be returned, e.g. 'wall1_45486'. (If the parameter is set, the 'filters' parameter is optional.);

• :start_time (Integer) —

  Earliest timestamp (in Unix time) of a comment to return. By default, 24 hours ago.

• :end_time (Integer) —

  Latest timestamp (in Unix time) of a comment to return. By default, the current time.

• :start_from (String) —

  Identificator needed to return the next oage with results. Value for this parameter returns in 'next_from' field.

• :fields (Array) —

  Additional fields of and to return.

# File 'lib/vk/api/newsfeed/methods/get_comments.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns Number of comments to return. For auto feed, you can use the 'new_offset' parameter returned by this method.

Returns:

• (Integer) —

  Number of comments to return. For auto feed, you can use the 'new_offset' parameter returned by this method.

# File 'lib/vk/api/newsfeed/methods/get_comments.rb', line 29

attribute :count, API::Types::Coercible::Int.optional.default(30)

#end_time ⇒ Integer

Returns Latest timestamp (in Unix time) of a comment to return. By default, the current time.

Returns:

• (Integer) —

  Latest timestamp (in Unix time) of a comment to return. By default, the current time.

# File 'lib/vk/api/newsfeed/methods/get_comments.rb', line 37

attribute :end_time, API::Types::Coercible::Int.optional.default(nil)

#fields ⇒ Array

Returns Additional fields of and to return.

Returns:

• (Array) —

  Additional fields of and to return.

# File 'lib/vk/api/newsfeed/methods/get_comments.rb', line 41

attribute :fields, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#filters ⇒ Array

Returns Filters to apply:; 'post' — new comments on wall posts; 'photo' — new comments on photos; 'video' — new comments on videos; 'topic' — new comments on discussions; 'note' — new comments on notes;.

Returns:

• (Array) —

  Filters to apply:; 'post' — new comments on wall posts; 'photo' — new comments on photos; 'video' — new comments on videos; 'topic' — new comments on discussions; 'note' — new comments on notes;

# File 'lib/vk/api/newsfeed/methods/get_comments.rb', line 31

attribute :filters, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#reposts ⇒ String

Returns Object ID, comments on repost of which shall be returned, e.g. 'wall1_45486'. (If the parameter is set, the 'filters' parameter is optional.);.

Returns:

• (String) —

  Object ID, comments on repost of which shall be returned, e.g. 'wall1_45486'. (If the parameter is set, the 'filters' parameter is optional.);

# File 'lib/vk/api/newsfeed/methods/get_comments.rb', line 33

attribute :reposts, API::Types::Coercible::String.optional.default(nil)

#start_from ⇒ String

Returns Identificator needed to return the next oage with results. Value for this parameter returns in 'next_from' field.

Returns:

• (String) —

  Identificator needed to return the next oage with results. Value for this parameter returns in 'next_from' field.

# File 'lib/vk/api/newsfeed/methods/get_comments.rb', line 39

attribute :start_from, API::Types::Coercible::String.optional.default(nil)

#start_time ⇒ Integer

Returns Earliest timestamp (in Unix time) of a comment to return. By default, 24 hours ago.

Returns:

• (Integer) —

  Earliest timestamp (in Unix time) of a comment to return. By default, 24 hours ago.

# File 'lib/vk/api/newsfeed/methods/get_comments.rb', line 35

attribute :start_time, API::Types::Coercible::Int.optional.default(nil)