Class: Vk::API::Search::Methods::GetHints

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

Overview

Allows the programmer to do a quick search for any substring.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :q (String)

    Search query string.

  • :limit (Integer)

    Maximum number of results to return.

  • :filters (Array)
  • :search_global (Boolean)

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

Instance Method Details

#filtersArray

Returns:

  • (Array)

30
# File 'lib/vk/api/search/methods/get_hints.rb', line 30

attribute :filters, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#limitInteger

Returns Maximum number of results to return.

Returns:

  • (Integer)

    Maximum number of results to return.


28
# File 'lib/vk/api/search/methods/get_hints.rb', line 28

attribute :limit, API::Types::Coercible::Int.optional.default(9)

#qString

Returns Search query string.

Returns:

  • (String)

    Search query string.


26
# File 'lib/vk/api/search/methods/get_hints.rb', line 26

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

#search_globalBoolean

Returns:

  • (Boolean)

32
# File 'lib/vk/api/search/methods/get_hints.rb', line 32

attribute :search_global, API::Types::Form::Bool.optional.default(true)