376 lines
8.3 KiB
HTML
376 lines
8.3 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'>IwcConnector</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
IwcConnector
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>lib/Connectors/IwcConnector.coffee</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>The Iwc Connector adds support for the Inter-Widget-Communication protocol that is used in the Role-SDK.</p><p>You must not use your own IWC client when using this connector!!</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='http://dbis.rwth-aachen.de/cms/projects/the-xmpp-experience#interwidget-communication'>http://dbis.rwth-aachen.de/cms/projects/the-xmpp-experience#interwidget-communication</a>
|
|
</li>
|
|
<li>
|
|
<a href='http://dbis.rwth-aachen.de/cms/projects/ROLE'>http://dbis.rwth-aachen.de/cms/projects/ROLE</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#setIwcHandler-dynamic'>
|
|
#
|
|
(void)
|
|
<b>setIwcHandler</b><span>(f)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Set your own IWC handler.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#sendIwcIntent-dynamic'>
|
|
~
|
|
(void)
|
|
<b>sendIwcIntent intent</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Helper for sending iwc intents.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#send-dynamic'>
|
|
#
|
|
(void)
|
|
<b>send</b><span>(o)</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
This function is called whenever an operation was executed.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#receive-dynamic'>
|
|
#
|
|
(void)
|
|
<b>receive</b><span>(o)</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
This function is called whenever an operation was received from another peer.
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Constructor Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='constructor-dynamic'>
|
|
#
|
|
(void)
|
|
<b>constructor</b><span>(engine, HB, execution_listener, yatta)</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>engine</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Engine</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The transformation engine </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>HB</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>HistoryBuffer</tt>
|
|
)
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>execution_listener</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Array<Function></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>You must ensure that whenever an operation is executed, every function in this Array is called. </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>yatta</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>YattaFramework</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The Yatta framework. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='setIwcHandler-dynamic'>
|
|
#
|
|
(void)
|
|
<b>setIwcHandler</b><span>(f)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Set your own IWC handler. It will be called after Yatta consumed the
|
|
data from the received intent.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='sendIwcIntent-dynamic'>
|
|
~
|
|
(void)
|
|
<b>sendIwcIntent intent</b><span>()</span>
|
|
<br>
|
|
~
|
|
(void)
|
|
<b>sendIwcIntent action_name, content</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Helper for sending iwc intents.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<div class='overloads'>
|
|
<h3>Overloads:</h3>
|
|
<div class='overload'>
|
|
<p class='signature'>
|
|
~
|
|
(void)
|
|
<b>sendIwcIntent intent</b><span>()</span>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>intent</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Object</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The intent object. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='overload'>
|
|
<p class='signature'>
|
|
~
|
|
(void)
|
|
<b>sendIwcIntent action_name, content</b><span>()</span>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>action_name</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The name of the action that is going to be send. </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>content</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The content that is atteched to the intent. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='send-dynamic'>
|
|
#
|
|
(void)
|
|
<b>send</b><span>(o)</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>This function is called whenever an operation was executed.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>o</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Operation</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The operation that was executed. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='receive-dynamic'>
|
|
#
|
|
(void)
|
|
<b>receive</b><span>(o)</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>This function is called whenever an operation was received from another peer.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>o</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Operation</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The operation that was received. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
October 17, 14 12:58:33 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> |