Class: Vk::API::Database::Methods::GetCities
- Inherits:
-
Schema::Method
- Object
- Dry::Struct
- Schema::Method
- Vk::API::Database::Methods::GetCities
- Defined in:
- lib/vk/api/database/methods/get_cities.rb
Overview
Returns a list of cities.
Arguments collapse
-
#count ⇒ Integer
Number of cities to return.
-
#country_id ⇒ Integer
Country ID.
-
#need_all ⇒ Boolean
'1' — to return all cities in the country; '0' — to return major cities in the country (default);.
-
#offset ⇒ Integer
Offset needed to return a specific subset of cities.
-
#q ⇒ String
Search query.
-
#region_id ⇒ Integer
Region ID.
Instance Method Summary collapse
Methods inherited from Schema::Method
Constructor Details
#initialize(arguments) ⇒ Database::Methods::GetCities
|
# File 'lib/vk/api/database/methods/get_cities.rb', line 15
|
Instance Method Details
#count ⇒ Integer
Returns Number of cities to return.
38 |
# File 'lib/vk/api/database/methods/get_cities.rb', line 38 attribute :count, API::Types::Coercible::Int.optional.default(100) |
#country_id ⇒ Integer
Returns Country ID.
28 |
# File 'lib/vk/api/database/methods/get_cities.rb', line 28 attribute :country_id, API::Types::Coercible::Int |
#need_all ⇒ Boolean
Returns '1' — to return all cities in the country; '0' — to return major cities in the country (default);.
34 |
# File 'lib/vk/api/database/methods/get_cities.rb', line 34 attribute :need_all, API::Types::Form::Bool.optional.default(nil) |
#offset ⇒ Integer
Returns Offset needed to return a specific subset of cities.
36 |
# File 'lib/vk/api/database/methods/get_cities.rb', line 36 attribute :offset, API::Types::Coercible::Int.optional.default(nil) |