Class: DropboxApi::Endpoints::Files::Search

Inherits:
Rpc
  • Object
show all
Includes:
OptionsValidator
Defined in:
lib/dropbox_api/endpoints/files/search.rb

Constant Summary collapse

Method = 
:post
Path = 
'/2/files/search_v2'
ResultType = 
DropboxApi::Results::SearchV2Result
ErrorType = 
DropboxApi::Errors::SearchError

Instance Method Summary collapse

Methods included from OptionsValidator

#validate_options

Methods inherited from Rpc

#build_connection, #build_request, #request_body

Methods inherited from Base

add_endpoint, #initialize

Constructor Details

This class inherits a constructor from DropboxApi::Endpoints::Base

Instance Method Details

#search(query, options = nil, match_field_options = nil) ⇒ Object

Searches for files and folders.

Note: Recent changes may not immediately be reflected in search results due to a short delay in indexing.

Parameters:

  • query (String) —

    The string to search for. May match across multiple fields based on the request arguments.

  • options (DropboxApi::Metadata::SearchOptions) (defaults to: nil) —

    Options for more targeted search results. This field is optional.

  • match_field_options (DropboxApi::Metadata::SearchMatchFieldOptions) (defaults to: nil) —

    Options for search results match fields. This field is optional.



22
23
24
25
26
27
28
29
30
 
# File 'lib/dropbox_api/endpoints/files/search.rb', line 22

add_endpoint :search do |query, options = nil, match_field_options = nil|
  params = { query: query }

  params[:options] = options.to_hash unless options.nil?

  params[:match_field_options] = match_field_options.to_hash unless match_field_options.nil?

  perform_request(params)
end