blob: 0ba4fca72b5488fc019b40896b37f87a839ca6b0 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Selenium::WebDriver::Timeouts
&mdash; Documentation by YARD 0.8.1
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Selenium.html" title="Selenium (module)">Selenium</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../WebDriver.html" title="Selenium::WebDriver (module)">WebDriver</a></span></span>
&raquo;
<span class="title">Timeouts</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Selenium::WebDriver::Timeouts
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Selenium::WebDriver::Timeouts</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">rb/lib/selenium/webdriver/common/timeouts.rb</dd>
</dl>
<div class="clear"></div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#implicit_wait%3D-instance_method" title="#implicit_wait= (instance method)">- (Object) <strong>implicit_wait=</strong>(seconds) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set the amount of time the driver should wait when searching for elements.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Timeouts) <strong>initialize</strong>(bridge) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Timeouts.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#page_load%3D-instance_method" title="#page_load= (instance method)">- (Object) <strong>page_load=</strong>(seconds) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the amount of time to wait for a page load to complete before throwing
an error.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#script_timeout%3D-instance_method" title="#script_timeout= (instance method)">- (Object) <strong>script_timeout=</strong>(seconds) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the amount of time to wait for an asynchronous script to finish
execution before throwing an error.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::Timeouts (class)">Timeouts</a></span></tt>) <strong>initialize</strong>(bridge)
</h3><div class="docstring">
<div class="discussion">
<p>A new instance of Timeouts</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/timeouts.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_bridge'>bridge</span><span class='rparen'>)</span>
<span class='ivar'>@bridge</span> <span class='op'>=</span> <span class='id identifier rubyid_bridge'>bridge</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="implicit_wait=-instance_method">
- (<tt>Object</tt>) <strong>implicit_wait=</strong>(seconds)
</h3><div class="docstring">
<div class="discussion">
<p>Set the amount of time the driver should wait when searching for elements.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/timeouts.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_implicit_wait='>implicit_wait=</span><span class='lparen'>(</span><span class='id identifier rubyid_seconds'>seconds</span><span class='rparen'>)</span>
<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_setImplicitWaitTimeout'>setImplicitWaitTimeout</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_seconds'>seconds</span> <span class='op'>*</span> <span class='int'>1000</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="page_load=-instance_method">
- (<tt>Object</tt>) <strong>page_load=</strong>(seconds)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the amount of time to wait for a page load to complete before throwing
an error. If the timeout is negative, page loads can be indefinite.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/timeouts.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_page_load='>page_load=</span><span class='lparen'>(</span><span class='id identifier rubyid_seconds'>seconds</span><span class='rparen'>)</span>
<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_setTimeout'>setTimeout</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>page load</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_seconds'>seconds</span> <span class='op'>*</span> <span class='int'>1000</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="script_timeout=-instance_method">
- (<tt>Object</tt>) <strong>script_timeout=</strong>(seconds)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the amount of time to wait for an asynchronous script to finish
execution before throwing an error. If the timeout is negative, then the
script will be allowed to run indefinitely.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/timeouts.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_script_timeout='>script_timeout=</span><span class='lparen'>(</span><span class='id identifier rubyid_seconds'>seconds</span><span class='rparen'>)</span>
<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_setScriptTimeout'>setScriptTimeout</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_seconds'>seconds</span> <span class='op'>*</span> <span class='int'>1000</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jul 19 12:32:30 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.1 (ruby-1.9.3).
</div>
</body>
</html>