module DocumentCloud::API::Search
Constants
- SEARCH_PATH
Public Instance Methods
search(q, options={})
click to toggle source
Search
catalog of public documents
@see www.documentcloud.org/help/api @param q [String] The search query @param options [Hash] Customizable set of options @param options [Integer] :page Response page number @param options [Integer] :per_page The number of documents to return per page @param options [Boolean] :sections Include document sections in the results @param options [Boolean] :annotations Include document annotations in the results @param options [Boolean] :data Include key/value data in the results @param options [Integer] :mentions Include highlighted mentions of the search phrase @returns [DocumentCloud::SearchResults] Results of the search
# File lib/document_cloud/api/search.rb, line 19 def search(q, options={}) build_object DocumentCloud::SearchResults, get(SEARCH_PATH, options.merge(:q => q)) end