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

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Search::Methods::GetHints

Defined in:

lib/vk/api/search/methods/get_hints.rb

Overview

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

Arguments

• #filters ⇒ Array
• #limit ⇒ Integer

  Maximum number of results to return.

• #q ⇒ String

  Search query string.

• #search_global ⇒ Boolean

Instance Method Summary

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

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

#filters ⇒ Array

Returns:

• (Array)

# 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)

#limit ⇒ Integer

Returns Maximum number of results to return.

Returns:

• (Integer) —

  Maximum number of results to return.

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

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

#q ⇒ String

Returns Search query string.

Returns:

• (String) —

  Search query string.

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

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

#search_global ⇒ Boolean

Returns:

• (Boolean)

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

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