Class: Vk::API::Docs::Methods::Search

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/docs/methods/search.rb

Overview

Returns a list of documents matching the search criteria.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Docs::Methods::Search

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :q (String)

    Search query string.

  • :count (Integer)

    Number of results to return.

  • :offset (Integer)

    Offset needed to return a specific subset of results.



# File 'lib/vk/api/docs/methods/search.rb', line 15

Instance Method Details

#countInteger

Returns Number of results to return.

Returns:

  • (Integer)

    Number of results to return.



27
# File 'lib/vk/api/docs/methods/search.rb', line 27

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

#offsetInteger

Returns Offset needed to return a specific subset of results.

Returns:

  • (Integer)

    Offset needed to return a specific subset of results.



29
# File 'lib/vk/api/docs/methods/search.rb', line 29

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

#qString

Returns Search query string.

Returns:

  • (String)

    Search query string.



25
# File 'lib/vk/api/docs/methods/search.rb', line 25

attribute :q, API::Types::Coercible::String