Class: Sink::PageCursorNestedObjectRef

Inherits:
Object
  • Object
show all
Defined in:
lib/sink/page_cursor_nested_object_ref.rb

Defined Under Namespace

Classes: ObjectProp

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#data ⇒ Array

Returns:

  • (Array) 


19
20
21
 
# File 'lib/sink/page_cursor_nested_object_ref.rb', line 19

def data
  @data
end

#nested_object_cursor ⇒ String

Returns:

  • (String) 


22
23
24
 
# File 'lib/sink/page_cursor_nested_object_ref.rb', line 22

def nested_object_cursor
  @nested_object_cursor
end

#object_prop ⇒ ObjectProp

Returns:



25
26
27
 
# File 'lib/sink/page_cursor_nested_object_ref.rb', line 25

def object_prop
  @object_prop
end

Instance Method Details

#auto_paging_each(&blk) ⇒ nil

Returns:

  • (nil) 


54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/sink/page_cursor_nested_object_ref.rb', line 54

def auto_paging_each(&blk)
  if !blk
    raise "A block must be given to #auto_paging_each"
  end
  page = self
  loop do
    page.data.each { |e| blk.call(e) }
    break if !page.next_page?
    page = page.next_page
  end
end

#inspect ⇒ Object

Returns String.

Returns:

  • String



67
68
69
 
# File 'lib/sink/page_cursor_nested_object_ref.rb', line 67

def inspect
  "#<#{selfl.class}:0x#{object_id.to_s(16)} data=#{data.inspect} nested_object_cursor=#{nested_object_cursor.inspect} object_prop=#{object_prop.inspect}>"
end

#next_page ⇒ Sink::PageCursorNestedObjectRef

Returns:



46
47
48
49
50
51
 
# File 'lib/sink/page_cursor_nested_object_ref.rb', line 46

def next_page
  if !next_page?
    raise "No more pages available; please check #next_page? before calling #next_page"
  end
  client.request(Util.deep_merge(req, {query: {cursor: nested_object_cursor}}), opts)
end

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/sink/page_cursor_nested_object_ref.rb', line 41

def next_page?
  !nested_object_cursor.nil?
end