Class: Vk::API::Database::Methods::GetCountries

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

Overview

Returns a list of countries.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :need_all (Boolean) —

    '1' — to return a full list of all countries; '0' — to return a list of countries near the current user's country (default).;

  • :code (String) —

    Country codes in standard.

  • :offset (Integer) —

    Offset needed to return a specific subset of countries.

  • :count (Integer) —

    Number of countries to return.




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

Instance Method Details

#code ⇒ String

Returns Country codes in standard.

Returns:

  • (String) —

    Country codes in standard.



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

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

#count ⇒ Integer

Returns Number of countries to return.

Returns:

  • (Integer) —

    Number of countries to return.



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

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

#need_all ⇒ Boolean

Returns '1' — to return a full list of all countries; '0' — to return a list of countries near the current user's country (default).;.

Returns:

  • (Boolean) —

    '1' — to return a full list of all countries; '0' — to return a list of countries near the current user's country (default).;



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

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of countries.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of countries.



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

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