Class: Vk::API::Database::Methods::GetSchools

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Database::Methods::GetSchools

Defined in:

lib/vk/api/database/methods/get_schools.rb

Overview

Returns a list of schools.

Arguments

• #city_id ⇒ Integer

  City ID.

• #count ⇒ Integer

  Number of schools to return.

• #offset ⇒ Integer

  Offset needed to return a specific subset of schools.

• #q ⇒ String

  Search query.

Instance Method Summary

• #initialize(arguments) ⇒ Database::Methods::GetSchools constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :q (String) —

  Search query.

• :city_id (Integer) —

  City ID.

• :offset (Integer) —

  Offset needed to return a specific subset of schools.

• :count (Integer) —

  Number of schools to return.

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

Instance Method Details

#city_id ⇒ Integer

Returns City ID.

Returns:

• (Integer) —

  City ID.

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

attribute :city_id, API::Types::Coercible::Int

#count ⇒ Integer

Returns Number of schools to return.

Returns:

• (Integer) —

  Number of schools to return.

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

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of schools.

Returns:

• (Integer) —

  Offset needed to return a specific subset of schools.

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

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

#q ⇒ String

Returns Search query.

Returns:

• (String) —

  Search query.

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

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