Class: Vk::API::Search

Inherits:

Schema::Namespace

• Object
• Schema::Namespace
• Vk::API::Search

Defined in:

lib/vk/api/methods.rb,
lib/vk/api/objects.rb,
lib/vk/api/responses.rb,
lib/vk/api/search/hint.rb,
lib/vk/api/search/methods/get_hints.rb,
lib/vk/api/search/responses/get_hints_response.rb

Defined Under Namespace

Modules: Methods, Responses Classes: Hint

Instance Attribute Summary

Attributes inherited from Schema::Namespace

#client

DSL

• #get_hints(arguments = {}) ⇒ Vk::API::Search::Responses::GetHintsResponse

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

Methods inherited from Schema::Namespace

#call, #initialize

Constructor Details

This class inherits a constructor from Vk::Schema::Namespace

Instance Method Details

#get_hints(arguments = {}) ⇒ Vk::API::Search::Responses::GetHintsResponse

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

Parameters:

• arguments (Hash) (defaults to: {})

Options Hash (arguments):

• :q (String) —

  Search query string.

• :limit (Integer) — default: 9 —

  Maximum number of results to return.

• :filters (Array)
• :search_global (Boolean) — default: true

Returns:

• (Vk::API::Search::Responses::GetHintsResponse) —

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

See Also:

• Vk::API::Search::Methods::GetHints

# File 'lib/vk/api/methods.rb', line 5243

def get_hints(arguments = {})
  require "vk/api/search/methods/get_hints"
  method = Methods::GetHints.new(arguments)
  response = method.call(@client)
  require "vk/api/search/responses/get_hints_response"
  Responses::GetHintsResponse.new(response.deep_symbolize_keys)
end