Class: Vk::API::Market::Methods::GetComments

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

Overview

Returns comments list for an item.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer) —

    ID of an item owner community

  • :item_id (Integer) —

    Item ID.

  • :need_likes (Boolean) —

    '1' — to return likes info.

  • :start_comment_id (Integer) —

    ID of a comment to start a list from (details below).

  • :count (Integer) —

    Number of results to return.

  • :sort (String) —

    Sort order ('asc' — from old to new, 'desc' — from new to old)

  • :extended (Boolean) —

    '1' — comments will be returned as numbered objects, in addition lists of 'profiles' and 'groups' objects will be returned.

  • :fields (Array) —

    List of additional profile fields to return. See the [vk.com/dev/fields|details]




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

Instance Method Details

#count ⇒ Integer

Returns Number of results to return.

Returns:

  • (Integer) —

    Number of results to return.



38
 
# File 'lib/vk/api/market/methods/get_comments.rb', line 38

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

#extended ⇒ Boolean

Returns '1' — comments will be returned as numbered objects, in addition lists of 'profiles' and 'groups' objects will be returned.

Returns:

  • (Boolean) —

    '1' — comments will be returned as numbered objects, in addition lists of 'profiles' and 'groups' objects will be returned.



42
 
# File 'lib/vk/api/market/methods/get_comments.rb', line 42

attribute :extended, API::Types::Form::Bool.optional.default(nil)

#fields ⇒ Array

Returns List of additional profile fields to return. See the [vk.com/dev/fields|details].

Returns:

  • (Array) —

    List of additional profile fields to return. See the [vk.com/dev/fields|details]



44
 
# File 'lib/vk/api/market/methods/get_comments.rb', line 44

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

#item_id ⇒ Integer

Returns Item ID.

Returns:

  • (Integer) —

    Item ID.



32
 
# File 'lib/vk/api/market/methods/get_comments.rb', line 32

attribute :item_id, API::Types::Coercible::Int

#need_likes ⇒ Boolean

Returns '1' — to return likes info.

Returns:

  • (Boolean) —

    '1' — to return likes info.



34
 
# File 'lib/vk/api/market/methods/get_comments.rb', line 34

attribute :need_likes, API::Types::Form::Bool.optional.default(nil)

#owner_id ⇒ Integer

Returns ID of an item owner community.

Returns:

  • (Integer) —

    ID of an item owner community



30
 
# File 'lib/vk/api/market/methods/get_comments.rb', line 30

attribute :owner_id, API::Types::Coercible::Int

#sort ⇒ String

Returns Sort order ('asc' — from old to new, 'desc' — from new to old).

Returns:

  • (String) —

    Sort order ('asc' — from old to new, 'desc' — from new to old)



40
 
# File 'lib/vk/api/market/methods/get_comments.rb', line 40

attribute :sort, API::Types::Coercible::String.enum("asc", "desc").optional.default("asc")

#start_comment_id ⇒ Integer

Returns ID of a comment to start a list from (details below).

Returns:

  • (Integer) —

    ID of a comment to start a list from (details below).



36
 
# File 'lib/vk/api/market/methods/get_comments.rb', line 36

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