joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions
pickles/docs/PICKLES/API_Tinychat.html
Josh Sherman 54372d24b7 Updated the last few URL's that were wrong, also generated a new copy of the documentation 
Should probably made the documentation piece pre-commit hook or something
2012-10-03 17:46:27 -04:00

332 lines
No EOL
15 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="iso-8859-1"?>
<!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">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class API_Tinychat</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class API_Tinychat</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Tinychat API Interface</p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://tinychat.com/developer/docs">http://tinychat.com/developer/docs</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_classes---API---Tinychat.php.html">/classes/API/Tinychat.php</a> (line <span class="field">23</span>)
</p>
<pre>API_Common
|
--API_Tinychat</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">API_Tinychat</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#generateHTML" title="details" class="method-name">generateHTML</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$join</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$nick</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$change</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$login</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$oper</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$owner</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$bcast</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$api</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$colorbk</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$tcdisplay</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$autoop</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$urlsuper</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$langdefault</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#listRooms" title="details" class="method-name">listRooms</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#roomInfo" title="details" class="method-name">roomInfo</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$with_ip</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#setBroadcastPassword" title="details" class="method-name">setBroadcastPassword</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">''</span>])
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#setRoomPassword" title="details" class="method-name">setRoomPassword</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">''</span>])
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">46</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Assigns our public and secret keys from the configuration.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">API_Tinychat</span>
<span class="method-name">
__construct
</span>
()
</div>
</div>
<a name="methodgenerateHTML" id="generateHTML"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">generateHTML</span> (line <span class="line-number">157</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generate HTML</p>
<p class="description"><p>Creates the HTML to place a chat on a site.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">todo:</span> List params...</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
generateHTML
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$join</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$nick</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$change</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$login</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$oper</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$owner</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$bcast</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$api</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$colorbk</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$tcdisplay</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$autoop</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$urlsuper</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$langdefault</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$room</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$join</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$nick</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$change</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$login</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$oper</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$owner</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$bcast</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$api</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$colorbk</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$tcdisplay</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$autoop</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$urlsuper</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$langdefault</span> </li>
</ul>
</div>
<a name="methodlistRooms" id="listRooms"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">listRooms</span> (line <span class="line-number">100</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">List Rooms</p>
<p class="description"><p>Pulls all rooms for the API application.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
listRooms
</span>
()
</div>
</div>
<a name="methodroomInfo" id="roomInfo"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">roomInfo</span> (line <span class="line-number">114</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Room Info</p>
<p class="description"><p>Pulls the information for a room.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
roomInfo
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$with_ip</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$room</span><span class="var-description">: name of the room</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$with_ip</span><span class="var-description">: whether or not to include users IP addresses</span> </li>
</ul>
</div>
<a name="methodsetBroadcastPassword" id="setBroadcastPassword"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setBroadcastPassword</span> (line <span class="line-number">144</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Broadcast Password</p>
<p class="description"><p>Sets the password to allow broadcasting in the room. Only users with the correct password will be able to broadcast.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
setBroadcastPassword
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$room</span><span class="var-description">: name of the room</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$password</span><span class="var-description">: password to use, blank for no password</span> </li>
</ul>
</div>
<a name="methodsetRoomPassword" id="setRoomPassword"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setRoomPassword</span> (line <span class="line-number">129</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set Room Password</p>
<p class="description"><p>Sets the password for the room, only users with the correct password will be able to enter.</p></p>
<ul class="tags">
<li><span class="field">return:</span> API results</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
setRoomPassword
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$room</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">''</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$room</span><span class="var-description">: name of the room</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$password</span><span class="var-description">: password to use, blank for no password</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 03 Oct 2012 17:46:06 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
</p>
</div></body>
</html>
Reference in a new issue View git blame Copy permalink