nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-02-18 04:13:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
davical/docs/api/davical/xmpp.html
Andrew McMillan 5c51146116 Updated docs for 0.9.8.3
2010-02-25 12:35:20 +13:00

746 lines
25 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 xmpp</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"><img src="../media/images/Class_logo.png"
alt=" Class"
title=" Class"
style="vertical-align: middle"> xmpp</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <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">********************************************************************</p>
<p class="description"><p>XMPP PubSub for DAViCal Copyright 2009 Rob Ostensen rob@boxacle.net Licenced http://gnu.org/copyleft/gpl.html GNU GPL v2</p><p>*******************************************************************</p></p>
<p class="notes">
Located in <a class="field" href="_inc---pubsub.php.html">/inc/pubsub.php</a> (line <span class="field">11</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$idle" title="details" class="var-name">$idle</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$jid" title="details" class="var-name">$jid</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$password" title="details" class="var-name">$password</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$port" title="details" class="var-name">$port</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$pubsubLayout" title="details" class="var-name">$pubsubLayout</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$resource" title="details" class="var-name">$resource</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$server" title="details" class="var-name">$server</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$status" title="details" class="var-name">$status</a>
</div>
<div class="var-title">
<img src="../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$tls" title="details" class="var-name">$tls</a>
</div>
</div>
</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> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">
<img src="../media/images/Constructor.png" alt=" "/>
<span class="method-result">xmpp</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#addHandler" title="details" class="method-name">addHandler</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$direction</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$command</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$handler</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#close" title="details" class="method-name">close</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#open" title="details" class="method-name">open</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$jid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#pubsubConfig" title="details" class="method-name">pubsubConfig</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#pubsubCreate" title="details" class="method-name">pubsubCreate</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$configure</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#pubsubDelete" title="details" class="method-name">pubsubDelete</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#pubsubPublish" title="details" class="method-name">pubsubPublish</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contents</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$nodeId</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#pubsubPurge" title="details" class="method-name">pubsubPurge</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#sendMessage" title="details" class="method-name">sendMessage</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$idle" id="$idle"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$idle</span>
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$jid" id="$jid"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$jid</span>
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$password" id="$password"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$password</span>
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$port" id="$port"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$port</span>
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$pubsubLayout" id="$pubsubLayout"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$pubsubLayout</span>
= <span class="var-default">'hometree'</span> (line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$resource" id="$resource"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$resource</span>
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$server" id="$server"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$server</span>
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$status" id="$status"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$status</span>
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$tls" id="$tls"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$tls</span>
(line <span class="line-number">23</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</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-var-summary">Vars</a> (<a href="#sec-vars">details</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="evenrow">
<div class="method-header">
<img src="../media/images/Constructor.png" />
<span class="method-title">Constructor __construct</span> (line <span class="line-number">26</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">xmpp</span>
<span class="method-name">
__construct
</span>
()
</div>
</div>
<a name="methodaddHandler" id="addHandler"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">addHandler</span> (line <span class="line-number">673</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
addHandler
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$direction</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$command</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$handler</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$direction</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$command</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$handler</span> </li>
</ul>
</div>
<a name="methodclose" id="close"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">close</span> (line <span class="line-number">662</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
close
</span>
()
</div>
</div>
<a name="methodopen" id="open"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">open</span> (line <span class="line-number">645</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
open
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$jid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$password</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$jid</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$password</span> </li>
</ul>
</div>
<a name="methodpubsubConfig" id="pubsubConfig"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">pubsubConfig</span> (line <span class="line-number">295</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
pubsubConfig
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$to</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
</ul>
</div>
<a name="methodpubsubCreate" id="pubsubCreate"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">pubsubCreate</span> (line <span class="line-number">259</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
pubsubCreate
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$configure</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$to</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$configure</span> </li>
</ul>
</div>
<a name="methodpubsubDelete" id="pubsubDelete"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">pubsubDelete</span> (line <span class="line-number">312</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
pubsubDelete
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$to</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
</ul>
</div>
<a name="methodpubsubPublish" id="pubsubPublish"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">pubsubPublish</span> (line <span class="line-number">346</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
pubsubPublish
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contents</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$nodeId</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$to</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$contents</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$nodeId</span> </li>
</ul>
</div>
<a name="methodpubsubPurge" id="pubsubPurge"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">pubsubPurge</span> (line <span class="line-number">329</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
pubsubPurge
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$to</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
</ul>
</div>
<a name="methodsendMessage" id="sendMessage"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">sendMessage</span> (line <span class="line-number">249</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
sendMessage
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$to</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$to</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$message</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 25 Feb 2010 11:39:20 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
Reference in New Issue View Git Blame Copy Permalink