Class: Vk::API::Database::Methods::GetRegions

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

Overview

Returns a list of regions.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Database::Methods::GetRegions

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :country_id (Integer)

    Country ID, received in method.

  • :q (String)

    Search query.

  • :offset (Integer)

    Offset needed to return specific subset of regions.

  • :count (Integer)

    Number of regions to return.


# File 'lib/vk/api/database/methods/get_regions.rb', line 15

Instance Method Details

#countInteger

Returns Number of regions to return.

Returns:

  • (Integer)

    Number of regions to return.


32
# File 'lib/vk/api/database/methods/get_regions.rb', line 32

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

#country_idInteger

Returns Country ID, received in method.

Returns:

  • (Integer)

    Country ID, received in method.


26
# File 'lib/vk/api/database/methods/get_regions.rb', line 26

attribute :country_id, API::Types::Coercible::Int

#offsetInteger

Returns Offset needed to return specific subset of regions.

Returns:

  • (Integer)

    Offset needed to return specific subset of regions.


30
# File 'lib/vk/api/database/methods/get_regions.rb', line 30

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

#qString

Returns Search query.

Returns:

  • (String)

    Search query.


28
# File 'lib/vk/api/database/methods/get_regions.rb', line 28

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