Contents

# frozen_string_literal: true
require 'vk/api/methods'

module Vk
  module API
    class Search < Vk::Schema::Namespace
      module Methods
        # Allows the programmer to do a quick search for any substring.
        class GetHints < Schema::Method
          # @!group Properties

          self.open = false
          self.method = 'search.getHints'

          # @method initialize(arguments)
          #   @param [Hash] arguments
          #   @option arguments [String] :q Search query string.
          #   @option arguments [Integer] :limit Maximum number of results to return.
          #   @option arguments [Array] :filters 
          #   @option arguments [Boolean] :search_global 
          #   @return [Search::Methods::GetHints]

          # @!group Arguments

          # @return [String] Search query string.
          attribute :q, API::Types::Coercible::String.optional
          # @return [Integer] Maximum number of results to return.
          attribute :limit, API::Types::Coercible::Int.optional
          # @return [Array] 
          attribute :filters, API::Types::Coercible::Array.optional
          # @return [Boolean] 
          attribute :search_global, API::Types::Bool.optional
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vk-0.99.5.53.alpha	lib/vk/api/search/methods/get_hints.rb