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

Inherits:

Schema::Method

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

Defined in:

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

Overview

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

Arguments

• #count ⇒ Integer

  Number of faculties to return.

• #offset ⇒ Integer

  Offset needed to return a specific subset of faculties.

• #university_id ⇒ Integer

  University ID.

Instance Method Summary

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

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

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.

Parameters:

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

Instance Method Details

#count ⇒ Integer

Returns Number of faculties to return.

Returns:

• Number of faculties to return.

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

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of faculties.

Returns:

• Offset needed to return a specific subset of faculties.

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

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

#university_id ⇒ Integer

Returns University ID.

Returns:

• University ID.

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

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