Class: Uploadcare::Collections::FileSearchResult

Inherits:
Paginated
  • Object
show all
Defined in:
lib/uploadcare/collections/file_search_result.rb

Overview

Paginated results returned by the file search endpoint.

Search pagination uses POST requests, so every subsequent page must resend the original JSON search criteria while following the query parameters supplied by the API's next or previous URL.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ FileSearchResult

Returns a new instance of FileSearchResult.



12
13
14
15
16
 
# File 'lib/uploadcare/collections/file_search_result.rb', line 12

def initialize(params = {})
  @search_params = immutable_copy(params[:search_params] || {})
  @search_query = immutable_copy(params[:search_query] || {})
  super
end

Instance Attribute Details

#search_params ⇒ Hash (readonly)

Returns JSON search criteria resent for subsequent pages.

Returns:

  • (Hash) —

    JSON search criteria resent for subsequent pages



10
11
12
 
# File 'lib/uploadcare/collections/file_search_result.rb', line 10

def search_params
  @search_params
end

#search_query ⇒ Hash (readonly)

Returns JSON search criteria resent for subsequent pages.

Returns:

  • (Hash) —

    JSON search criteria resent for subsequent pages



10
11
12
 
# File 'lib/uploadcare/collections/file_search_result.rb', line 10

def search_query
  @search_query
end