Class: Puppeteer::Frame

Inherits:
Object
  • Object
show all
Defined in:
lib/puppeteer/frame.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(frame_manager, client, parent_frame, frame_id) ⇒ Frame

Returns a new instance of Frame.

Parameters:



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/puppeteer/frame.rb', line 8

def initialize(frame_manager, client, parent_frame, frame_id)
  @frame_manager = frame_manager
  @client = client
  @parent_frame = parent_frame
  @id = frame_id
  @detached = false

  @loader_id = ''
  @lifecycle_events = Set.new
  @main_world = Puppeteer::DOMWorld.new(frame_manager, self, frame_manager.timeout_settings)
  @secondary_world = Puppeteer::DOMWorld.new(frame_manager, self, frame_manager.timeout_settings)
  @child_frames = Set.new
  if parent_frame
    parent_frame._child_frames << self
  end
end

Instance Attribute Details

#frame_manager ⇒ Object

Returns the value of attribute frame_manager.



25
26
27
 
# File 'lib/puppeteer/frame.rb', line 25

def frame_manager
  @frame_manager
end

#id ⇒ Object

Returns the value of attribute id.



25
26
27
 
# File 'lib/puppeteer/frame.rb', line 25

def id
  @id
end

#lifecycle_events ⇒ Object

Returns the value of attribute lifecycle_events.



25
26
27
 
# File 'lib/puppeteer/frame.rb', line 25

def lifecycle_events
  @lifecycle_events
end

#loader_id ⇒ Object

Returns the value of attribute loader_id.



25
26
27
 
# File 'lib/puppeteer/frame.rb', line 25

def loader_id
  @loader_id
end

#main_world ⇒ Object

Returns the value of attribute main_world.



25
26
27
 
# File 'lib/puppeteer/frame.rb', line 25

def main_world
  @main_world
end

#secondary_world ⇒ Object

Returns the value of attribute secondary_world.



25
26
27
 
# File 'lib/puppeteer/frame.rb', line 25

def secondary_world
  @secondary_world
end

Instance Method Details

#add_script_tag(script_tag) ⇒ !Promise<!ElementHandle>

Parameters:

Returns:



154
155
156
 
# File 'lib/puppeteer/frame.rb', line 154

def add_script_tag(script_tag)
  @main_world.add_script_tag(script_tag)
end

#add_style_tag(style_tag) ⇒ !Promise<!ElementHandle>

Parameters:

Returns:



160
161
162
 
# File 'lib/puppeteer/frame.rb', line 160

def add_style_tag(style_tag)
  @main_world.add_style_tag(style_tag)
end

#child_frames ⇒ Object 



144
145
146
 
# File 'lib/puppeteer/frame.rb', line 144

def child_frames
  @child_frames.to_a
end

#click(selector, delay: nil, button: nil, click_count: nil) ⇒ Object

Parameters:

  • selector (String)
  • delay (Number) (defaults to: nil)
  • button (String) (defaults to: nil) —

    “left”|“right”|“middle”

  • click_count (Number) (defaults to: nil) 


168
169
170
 
# File 'lib/puppeteer/frame.rb', line 168

def click(selector, delay: nil, button: nil, click_count: nil)
  @secondary_world.click(selector, delay: delay, button: button, click_count: click_count)
end

#content ⇒ String

Returns:

  • (String) 


114
115
116
 
# File 'lib/puppeteer/frame.rb', line 114

def content
  @secondary_world.content
end

#detach ⇒ Object 



296
297
298
299
300
301
302
303
304
 
# File 'lib/puppeteer/frame.rb', line 296

def detach
  @detached = true
  @main_world.detach
  @secondary_world.detach
  if @parent_frame
    @parent_frame._child_frames.delete(self)
  end
  @parent_frame = nil
end

#detached? ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/puppeteer/frame.rb', line 148

def detached?
  @detached
end

#evaluate(page_function, *args) ⇒ Object

Parameters:

  • pageFunction (Function|string)
  • args (!Array<*>) 


58
59
60
 
# File 'lib/puppeteer/frame.rb', line 58

def evaluate(page_function, *args)
  @main_world.evaluate(page_function, *args)
end

#evaluate_handle(page_function, *args) ⇒ !Promise<!Puppeteer.JSHandle>

Parameters:

  • pageFunction (Function|string)

Returns:



50
51
52
 
# File 'lib/puppeteer/frame.rb', line 50

def evaluate_handle(page_function, *args)
  @main_world.evaluate_handle(page_function, *args)
end

#execution_context ⇒ Object 



44
45
46
 
# File 'lib/puppeteer/frame.rb', line 44

def execution_context
  @main_world.execution_context
end

#focus(selector) ⇒ Object

Parameters:

  • selector (string) 


175
176
177
 
# File 'lib/puppeteer/frame.rb', line 175

def focus(selector)
  @secondary_world.focus(selector)
end

#goto(url, referer: nil, timeout: nil, wait_until: nil) ⇒ Puppeteer::Response

Parameters:

  • url (String)
  • rederer (String)
  • timeout (number|nil) (defaults to: nil)
  • wait_until (string|nil) (defaults to: nil) —

    ‘load’ | ‘domcontentloaded’ | ‘networkidle0’ | ‘networkidle2’

Returns:



32
33
34
 
# File 'lib/puppeteer/frame.rb', line 32

def goto(url, referer: nil, timeout: nil, wait_until: nil)
  @frame_manager.navigate_frame(self, url, referer: referer, timeout: timeout, wait_until: wait_until)
end

#handle_lifecycle_event(loader_id, name) ⇒ Object 



283
284
285
286
287
288
289
 
# File 'lib/puppeteer/frame.rb', line 283

def handle_lifecycle_event(loader_id, name)
  if name == 'init'
    @loader_id = loader_id
    @lifecycle_events.clear
  end
  @lifecycle_events << name
end

#handle_loading_stopped ⇒ Object 



291
292
293
294
 
# File 'lib/puppeteer/frame.rb', line 291

def handle_loading_stopped
  @lifecycle_events << 'DOMContentLoaded'
  @lifecycle_events << 'load'
end

#hover(selector) ⇒ Object

Parameters:

  • selector (string) 


182
183
184
 
# File 'lib/puppeteer/frame.rb', line 182

def hover(selector)
  @secondary_world.hover(selector)
end

#name ⇒ String

Returns:

  • (String) 


126
127
128
 
# File 'lib/puppeteer/frame.rb', line 126

def name
  @name || ''
end

#navigated(frame_payload) ⇒ Object

Parameters:

  • frame_payload (Hash) 


267
268
269
270
271
272
273
274
275
276
 
# File 'lib/puppeteer/frame.rb', line 267

def navigated(frame_payload)
  @name = frame_payload['name']
  # TODO(lushnikov): remove this once requestInterception has loaderId exposed.
  @navigation_url = frame_payload['url']
  @url = frame_payload['url']

  # Ensure loaderId updated.
  # The order of [Page.lifecycleEvent name="init"] and [Page.frameNavigated] is random... for some reason...
  @loader_id = frame_payload['loaderId']
end

#navigated_within_document(url) ⇒ Object

Parameters:

  • url (String) 


279
280
281
 
# File 'lib/puppeteer/frame.rb', line 279

def navigated_within_document(url)
  @url = url
end

#parent_frame ⇒ Frame?

Returns:



136
137
138
 
# File 'lib/puppeteer/frame.rb', line 136

def parent_frame
  @parent_frame
end

#S(selector) ⇒ !Promise<?Puppeteer.ElementHandle>

‘$()` in JavaScript. $ is not allowed to use as a method name in Ruby.

Parameters:

  • selector (string)

Returns:



67
68
69
 
# File 'lib/puppeteer/frame.rb', line 67

def S(selector)
  @main_world.S(selector)
end

#select(selector, *values) ⇒ !Promise<!Array<string>>

Parameters:

  • selector (string)
  • values (!Array<string>)

Returns:

  • (!Promise<!Array<string>>) 


189
190
191
 
# File 'lib/puppeteer/frame.rb', line 189

def select(selector, *values)
  @secondary_world.select(selector, *values)
end

#set_content(html, timeout: nil, wait_until: nil) ⇒ Object

Parameters:

  • html (String)
  • timeout (Integer) (defaults to: nil)
  • wait_until (String|Array<String>) (defaults to: nil) 


121
122
123
 
# File 'lib/puppeteer/frame.rb', line 121

def set_content(html, timeout: nil, wait_until: nil)
  @secondary_world.set_content(html, timeout: timeout, wait_until: wait_until)
end

#Seval(selector, page_function, *args) ⇒ !Promise<(!Object|undefined)>

‘$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.

Parameters:

  • selector (string)
  • pageFunction (Function|string)
  • args (!Array<*>)

Returns:

  • (!Promise<(!Object|undefined)>) 


87
88
89
 
# File 'lib/puppeteer/frame.rb', line 87

def Seval(selector, page_function, *args)
  @main_world.Seval(selector, page_function, *args)
end

#SS(selector) ⇒ !Promise<!Array<!Puppeteer.ElementHandle>>

‘$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.

Parameters:

  • selector (string)

Returns:



107
108
109
 
# File 'lib/puppeteer/frame.rb', line 107

def SS(selector)
  @main_world.SS(selector)
end

#SSeval(selector, page_function, *args) ⇒ !Promise<(!Object|undefined)>

‘$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.

Parameters:

  • selector (string)
  • pageFunction (Function|string)
  • args (!Array<*>)

Returns:

  • (!Promise<(!Object|undefined)>) 


98
99
100
 
# File 'lib/puppeteer/frame.rb', line 98

def SSeval(selector, page_function, *args)
  @main_world.SSeval(selector, page_function, *args)
end

#Sx(expression) ⇒ !Promise<!Array<!Puppeteer.ElementHandle>>

‘$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.

Parameters:

  • expression (string)

Returns:



76
77
78
 
# File 'lib/puppeteer/frame.rb', line 76

def Sx(expression)
  @main_world.Sx(expression)
end

#tap(selector) ⇒ Object

Parameters:

  • selector (string) 


196
197
198
 
# File 'lib/puppeteer/frame.rb', line 196

def tap(selector)
  @secondary_world.tap(selector)
end

#title ⇒ String

Returns:

  • (String) 


262
263
264
 
# File 'lib/puppeteer/frame.rb', line 262

def title
  @secondary_world.title
end

#type_text(selector, text, delay: nil) ⇒ Object

Parameters:

  • selector (String)
  • text (String)
  • delay (Number) (defaults to: nil) 


205
206
207
 
# File 'lib/puppeteer/frame.rb', line 205

def type_text(selector, text, delay: nil)
  @main_world.type_text(selector, text, delay: delay)
end

#url ⇒ String

Returns:

  • (String) 


131
132
133
 
# File 'lib/puppeteer/frame.rb', line 131

def url
  @url
end

#wait_for_function(page_function, args: [], polling: nil, timeout: nil) ⇒ Puppeteer::JSHandle

Parameters:

  • page_function (String)
  • args (Integer|Array) (defaults to: [])
  • polling (String) (defaults to: nil)
  • timeout (Integer) (defaults to: nil)

Returns:



255
256
257
 
# File 'lib/puppeteer/frame.rb', line 255

def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
  @main_world.wait_for_function(page_function, args: args, polling: polling, timeout: timeout)
end

#wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil) ⇒ Object

Parameters:

  • selector (String)
  • visible (Boolean) (defaults to: nil) —

    Wait for element visible (not ‘display: none’ nor ‘visibility: hidden’) on true. default to false.

  • hidden (Boolean) (defaults to: nil) —

    Wait for element invisible (‘display: none’ nor ‘visibility: hidden’) on true. default to false.

  • timeout (Integer) (defaults to: nil) 


215
216
217
218
219
220
221
222
223
224
 
# File 'lib/puppeteer/frame.rb', line 215

def wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil)
  handle = @secondary_world.wait_for_selector(selector, visible: visible, hidden: hidden, timeout: timeout)
  if !handle
    return nil
  end
  main_execution_context = @main_world.execution_context
  result = main_execution_context.adopt_element_handle(handle)
  handle.dispose
  result
end

#wait_for_timeout(milliseconds) ⇒ Object

Parameters:

  • milliseconds (Integer) —

    the number of milliseconds to wait.



229
230
231
 
# File 'lib/puppeteer/frame.rb', line 229

def wait_for_timeout(milliseconds)
  sleep(milliseconds / 1000.0)
end

#wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil) ⇒ Object

Parameters:

  • xpath (String)
  • visible (Boolean) (defaults to: nil) —

    Wait for element visible (not ‘display: none’ nor ‘visibility: hidden’) on true. default to false.

  • hidden (Boolean) (defaults to: nil) —

    Wait for element invisible (‘display: none’ nor ‘visibility: hidden’) on true. default to false.

  • timeout (Integer) (defaults to: nil) 


237
238
239
240
241
242
243
244
245
246
 
# File 'lib/puppeteer/frame.rb', line 237

def wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
  handle = @secondary_world.wait_for_xpath(xpath, visible: visible, hidden: hidden, timeout: timeout)
  if !handle
    return nil
  end
  main_execution_context = @main_world.execution_context
  result = main_execution_context.adopt_element_handle(handle)
  handle.dispose
  result
end