Class: Vk::API::Market::Methods::Get

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

Overview

Returns items list for a community.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :owner_id (Integer)

    ID of an item owner community; "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "

  • :count (Integer)

    Number of items to return.

  • :offset (Integer)

    Offset needed to return a specific subset of results.

  • :extended (Boolean)

    '1' – method will return additional fields: 'likes, can_comment, car_repost, photos'. These parameters are not returned by default.


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

Instance Method Details

#countInteger

Returns Number of items to return.

Returns:

  • (Integer)

    Number of items to return.


28
# File 'lib/vk/api/market/methods/get.rb', line 28

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

#extendedBoolean

Returns '1' – method will return additional fields: 'likes, can_comment, car_repost, photos'. These parameters are not returned by default.

Returns:

  • (Boolean)

    '1' – method will return additional fields: 'likes, can_comment, car_repost, photos'. These parameters are not returned by default.


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

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

#offsetInteger

Returns Offset needed to return a specific subset of results.

Returns:

  • (Integer)

    Offset needed to return a specific subset of results.


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

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

#owner_idInteger

Returns ID of an item owner community; "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community ".

Returns:

  • (Integer)

    ID of an item owner community; "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "


26
# File 'lib/vk/api/market/methods/get.rb', line 26

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