Class: Vk::API::Database::Methods::GetFaculties

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

Overview

Returns a list of faculties (i.e., university departments).;

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :university_id (Integer)

    University ID.

  • :offset (Integer)

    Offset needed to return a specific subset of faculties.

  • :count (Integer)

    Number of faculties to return.


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

Instance Method Details

#countInteger

Returns Number of faculties to return.

Returns:

  • (Integer)

    Number of faculties to return.


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

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

#offsetInteger

Returns Offset needed to return a specific subset of faculties.

Returns:

  • (Integer)

    Offset needed to return a specific subset of faculties.


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

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

#university_idInteger

Returns University ID.

Returns:

  • (Integer)

    University ID.


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

attribute :university_id, API::Types::Coercible::Int