324 lines
6.4 KiB
HTML
324 lines
6.4 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='UTF-8'>
|
|
<title>Yatta! Documentation</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'>JsonYatta</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
JsonYatta
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>lib/Frameworks/JsonYatta.coffee</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>Framework for Json data-structures.
|
|
Known values that are supported:</p><ul>
|
|
<li>String</li>
|
|
<li>Integer</li>
|
|
<li>Array</li>
|
|
</ul>
|
|
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#getRootElement-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getRootElement</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
@result JsonType
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#getEngine-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getEngine</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#getConnector-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getConnector</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Get the initialized connector.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#getHistoryBuffer-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getHistoryBuffer</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#setMutableDefault-dynamic'>
|
|
#
|
|
(void)
|
|
<b>setMutableDefault</b><span>(mutable)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#getUserId-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getUserId</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Get the UserId from the HistoryBuffer object.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#val-dynamic'>
|
|
#
|
|
(void)
|
|
<b>val</b><span>(name, content, mutable)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</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>(user_id, Connector)</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='getRootElement-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getRootElement</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>@result JsonType</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='getEngine-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getEngine</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='../class/Engine.html'>Engine</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='getConnector-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getConnector</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Get the initialized connector.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='getHistoryBuffer-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getHistoryBuffer</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='../class/HistoryBuffer.html'>HistoryBuffer</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='setMutableDefault-dynamic'>
|
|
#
|
|
(void)
|
|
<b>setMutableDefault</b><span>(mutable)</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='JsonType.setMutableDefault'>JsonType.setMutableDefault</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='getUserId-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getUserId</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Get the UserId from the HistoryBuffer object.
|
|
In most cases this will be the same as the user_id value with which
|
|
JsonYatta was initialized (Depending on the HistoryBuffer implementation).</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='val-dynamic'>
|
|
#
|
|
(void)
|
|
<b>val</b><span>(name, content, mutable)</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='JsonType.val'>JsonType.val</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
August 05, 14 16:58:39 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> |