class Gini::Api::DocumentSet
Set of documents resulting from search or list query
Attributes
documents[R]
offset[R]
total[R]
Public Class Methods
new(api, data)
click to toggle source
Instantiate a new Gini::Api::Document
object from URL
@param [Gini::Api::Client] api Gini::Api::Client
object @param [Hash] data Container for documents @option data [Integer] :totalCount Total number of documents @option data [Aarray] :documents List of documents including all data
# File lib/gini-api/documentset.rb, line 20 def initialize(api, data) @total = data[:totalCount] @documents = data[:documents].map do |doc| Gini::Api::Document.new(api, doc[:_links][:document], doc) end end
Public Instance Methods
each() { |d| ... }
click to toggle source
Allow iteration on documents by yielding documents Required by Enumerable mixin
# File lib/gini-api/documentset.rb, line 30 def each @documents.each { |d| yield(d) } end