232 lines
5.0 KiB
HTML
232 lines
5.0 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='UTF-8'>
|
|
<title>Yatta! API</title>
|
|
<script src='../../../javascript/application.js'></script>
|
|
<script src='../../../javascript/search.js'></script>
|
|
<link rel='stylesheet' href='../../../stylesheets/application.css' type='text/css'>
|
|
</head>
|
|
<body>
|
|
<div id='base' data-path='../../../'></div>
|
|
<div id='header'>
|
|
<div id='menu'>
|
|
<a href='../../../extra/README.md.html' title='Yatta!'>
|
|
Yatta!
|
|
</a>
|
|
»
|
|
<a href='../../../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>lib</span>
|
|
»
|
|
<span class='title'>Connectors</span>
|
|
»
|
|
<span class='title'>PeerJsConnector.coffee</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
File:
|
|
PeerJsConnector.coffee
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>lib/Connectors</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Variables Summary</h2>
|
|
<dl class='constants'>
|
|
<dt id='module.exports-variable'>
|
|
module.exports
|
|
=
|
|
</dt>
|
|
<dd>
|
|
<pre><code class='coffeescript'>createPeerJsConnector</code></pre>
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2>Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#createPeerJsConnector-'>
|
|
~
|
|
(void)
|
|
<b>createPeerJsConnector peerjs_options, callback</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='createPeerJsConnector-'>
|
|
~
|
|
(void)
|
|
<b>createPeerJsConnector peerjs_options, callback</b><span>()</span>
|
|
<br>
|
|
~
|
|
(void)
|
|
<b>createPeerJsConnector peerjs_user_id, peerjs_options, callback</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<div class='overloads'>
|
|
<h3>Overloads:</h3>
|
|
<div class='overload'>
|
|
<p class='signature'>
|
|
~
|
|
(void)
|
|
<b>createPeerJsConnector peerjs_options, callback</b><span>()</span>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>peerjs_options</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Object</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>Is the options object that is passed to PeerJs. </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>callback</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Function</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The callback is called when the connector is initialized. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='overload'>
|
|
<p class='signature'>
|
|
~
|
|
(void)
|
|
<b>createPeerJsConnector peerjs_user_id, peerjs_options, callback</b><span>()</span>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>peerjs_user_id</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The user_id that is passed to PeerJs as the user_id and should be unique between all (also the unconnected) Peers. </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>peerjs_options</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Object</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>Is the options object that is passed to PeerJs. </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>callback</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Function</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The callback is called when the connector is initialized. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
September 26, 14 11:52:44 by
|
|
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
|
Codo
|
|
</a>
|
|
2.0.9
|
|
✲
|
|
Press H to see the keyboard shortcuts
|
|
✲
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
|
✲
|
|
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
|
|
</div>
|
|
<iframe id='search_frame'></iframe>
|
|
<div id='fuzzySearch'>
|
|
<input type='text'>
|
|
<ol></ol>
|
|
</div>
|
|
<div id='help'>
|
|
<p>
|
|
Quickly fuzzy find classes, mixins, methods, file:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>T</span>
|
|
Open fuzzy finder dialog
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
Control the navigation frame:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>L</span>
|
|
Toggle list view
|
|
</li>
|
|
<li>
|
|
<span>C</span>
|
|
Show class list
|
|
</li>
|
|
<li>
|
|
<span>I</span>
|
|
Show mixin list
|
|
</li>
|
|
<li>
|
|
<span>F</span>
|
|
Show file list
|
|
</li>
|
|
<li>
|
|
<span>M</span>
|
|
Show method list
|
|
</li>
|
|
<li>
|
|
<span>E</span>
|
|
Show extras list
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
You can focus and blur the search input:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>S</span>
|
|
Focus search input
|
|
</li>
|
|
<li>
|
|
<span>Esc</span>
|
|
Blur search input
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html> |