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

Inherits:
Schema::Method
  • Object
show all
Defined in:
lib/vk/api/newsfeed/methods/get_comments.rb

Overview

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

Arguments collapse

Instance Method Summary collapse

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

#countInteger

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.


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

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

#end_timeInteger

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.


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

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

#fieldsArray

Returns Additional fields of and to return.

Returns:

  • (Array)

    Additional fields of and to return.


41
# 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)

#filtersArray

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;


31
# 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)

#repostsString

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.);


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

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

#start_fromString

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.


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

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

#start_timeInteger

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.


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

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