Class: Vk::API::Database::Methods::GetChairs

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

Overview

Returns list of chairs on a specified faculty.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :faculty_id (Integer) —

    id of the faculty to get chairs from

  • :offset (Integer) —

    offset required to get a certain subset of chairs

  • :count (Integer) —

    amount of chairs to get




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

Instance Method Details

#count ⇒ Integer

Returns amount of chairs to get.

Returns:

  • (Integer) —

    amount of chairs to get



29
 
# File 'lib/vk/api/database/methods/get_chairs.rb', line 29

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

#faculty_id ⇒ Integer

Returns id of the faculty to get chairs from.

Returns:

  • (Integer) —

    id of the faculty to get chairs from



25
 
# File 'lib/vk/api/database/methods/get_chairs.rb', line 25

attribute :faculty_id, API::Types::Coercible::Int

#offset ⇒ Integer

Returns offset required to get a certain subset of chairs.

Returns:

  • (Integer) —

    offset required to get a certain subset of chairs



27
 
# File 'lib/vk/api/database/methods/get_chairs.rb', line 27

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