Initial Commit

This commit is contained in:
G. Gibson 2021-11-16 08:41:53 -08:00
commit 4bb9f2f2ea
189 changed files with 135079 additions and 2 deletions

158
doc/Blather/Client.html Normal file
View file

@ -0,0 +1,158 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::Client - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-unbind">#unbind</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::Client">
<h1 id="class-Blather::Client" class="class">
class Blather::Client
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-unbind" class="method-detail ">
<div class="method-heading">
<span class="method-name">unbind</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="unbind-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unbind</span>
<span class="ruby-comment"># Fix bug where closing connection stops EM for ALL Client Instances.</span>
<span class="ruby-comment"># call_handler_for(:disconnected, nil) || (EM.reactor_running? &amp;&amp; EM.stop)</span>
<span class="ruby-identifier">call_handler_for</span>(<span class="ruby-value">:disconnected</span>, <span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

97
doc/Blather/DSL.html Normal file
View file

@ -0,0 +1,97 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Blather::DSL - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
</div>
</nav>
<main role="main" aria-labelledby="module-Blather::DSL">
<h1 id="module-Blather::DSL" class="module">
module Blather::DSL
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

View file

@ -0,0 +1,809 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::DSL::MultiUserChat - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-configuration">#configuration</a>
<li ><a href="#method-i-configuration-3D">#configuration=</a>
<li ><a href="#method-i-destroy">#destroy</a>
<li ><a href="#method-i-get_configuration">#get_configuration</a>
<li ><a href="#method-i-invite">#invite</a>
<li ><a href="#method-i-join">#join</a>
<li ><a href="#method-i-leave">#leave</a>
<li ><a href="#method-i-members">#members</a>
<li ><a href="#method-i-say">#say</a>
<li ><a href="#method-i-set_configuration">#set_configuration</a>
<li ><a href="#method-i-set_default_configuration">#set_default_configuration</a>
<li ><a href="#method-i-status-3D">#status=</a>
<li ><a href="#method-i-subject-3D">#subject=</a>
<li ><a href="#method-i-unlock">#unlock</a>
<li ><a href="#method-i-write">#write</a>
<li ><a href="#method-i-write_with_handler">#write_with_handler</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::DSL::MultiUserChat">
<h1 id="class-Blather::DSL::MultiUserChat" class="class">
class Blather::DSL::MultiUserChat
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(client, jid, nickname = nil, password = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 47</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">client</span>, <span class="ruby-identifier">jid</span>, <span class="ruby-identifier">nickname</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">password</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@client</span> = <span class="ruby-identifier">client</span>
<span class="ruby-ivar">@room</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">jid</span>)
<span class="ruby-ivar">@nickname</span> = <span class="ruby-identifier">nickname</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@room</span>.<span class="ruby-identifier">resource</span>
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
<span class="ruby-ivar">@room</span>.<span class="ruby-identifier">strip!</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-configuration" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">configuration</span><span
class="method-args">(&amp;block)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="MultiUserChat.html#method-i-get_configuration">get_configuration</a>
</div>
</div>
<div id="method-i-configuration-3D" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">configuration=</span><span
class="method-args">(values, &amp;block)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="MultiUserChat.html#method-i-set_configuration">set_configuration</a>
</div>
</div>
<div id="method-i-destroy" class="method-detail ">
<div class="method-heading">
<span class="method-name">destroy</span><span
class="method-args">(reason = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>&lt;iq from=&#39;crone1@shakespeare.lit/desktop&#39;</p>
<pre> id=&#39;begone&#39;
to=&#39;heath@chat.shakespeare.lit&#39;
type=&#39;set&#39;&gt;
&lt;query xmlns=&#39;http://jabber.org/protocol/muc#owner&#39;&gt;
&lt;destroy jid=&#39;darkcave@chat.shakespeare.lit&#39;&gt;
&lt;reason&gt;Macbeth doth come.&lt;/reason&gt;
&lt;/destroy&gt;
&lt;/query&gt;</pre>
<p>&lt;/iq&gt;</p>
<div class="method-source-code" id="destroy-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 120</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">destroy</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">destroy</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Owner</span><span class="ruby-operator">::</span><span class="ruby-constant">Destroy</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>)
<span class="ruby-identifier">destroy</span>.<span class="ruby-identifier">reason</span> = <span class="ruby-identifier">reason</span>
<span class="ruby-identifier">write</span> <span class="ruby-identifier">destroy</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_configuration" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_configuration</span><span
class="method-args">() { |stana| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="get_configuration-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 127</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_configuration</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">get_configure</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Owner</span><span class="ruby-operator">::</span><span class="ruby-constant">Configure</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:get</span>, <span class="ruby-ivar">@room</span>)
<span class="ruby-identifier">write_with_handler</span>(<span class="ruby-identifier">get_configure</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">stana</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">stana</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="MultiUserChat.html#method-i-configuration">configuration</a>
</div>
</div>
<div id="method-i-invite" class="method-detail ">
<div class="method-heading">
<span class="method-name">invite</span><span
class="method-args">(jid, reason = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>&lt;message to=&#39;room@service&#39;&gt;</p>
<pre>&lt;x xmlns=&#39;http://jabber.org/protocol/muc#user&#39;&gt;
&lt;invite to=&#39;jid&#39;&gt;
&lt;reason&gt;comment&lt;/reason&gt;
&lt;/invite&gt;
&lt;/x&gt;</pre>
<p>&lt;/message&gt;</p>
<div class="method-source-code" id="invite-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 81</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invite</span>(<span class="ruby-identifier">jid</span>, <span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">message</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">message</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Invite</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">jid</span>, <span class="ruby-identifier">reason</span>, <span class="ruby-ivar">@password</span>)
<span class="ruby-identifier">write</span> <span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-join" class="method-detail ">
<div class="method-heading">
<span class="method-name">join</span><span
class="method-args">(reason = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="join-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 55</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">join</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">join</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Presence</span><span class="ruby-operator">::</span><span class="ruby-constant">MUCJoin</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">join</span>.<span class="ruby-identifier">to</span> = <span class="ruby-node">&quot;#{@room}/#{@nickname}&quot;</span>
<span class="ruby-identifier">join</span>.<span class="ruby-identifier">password</span> = <span class="ruby-ivar">@password</span>
<span class="ruby-identifier">write</span> <span class="ruby-identifier">join</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-leave" class="method-detail ">
<div class="method-heading">
<span class="method-name">leave</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="leave-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">leave</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">status</span> = <span class="ruby-value">:unavailable</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-members" class="method-detail ">
<div class="method-heading">
<span class="method-name">members</span><span
class="method-args">(&amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>&lt;iq from=&#39;crone1@shakespeare.lit/desktop&#39;</p>
<pre> id=&#39;member3&#39;
to=&#39;darkcave@chat.shakespeare.lit&#39;
type=&#39;get&#39;&gt;
&lt;query xmlns=&#39;http://jabber.org/protocol/muc#admin&#39;&gt;
&lt;item affiliation=&#39;member&#39;/&gt;
&lt;/query&gt;</pre>
<p>&lt;/iq&gt;</p>
<p>&lt;iq from=&#39;darkcave@chat.shakespeare.lit&#39;</p>
<pre> id=&#39;member3&#39;
to=&#39;crone1@shakespeare.lit/desktop&#39;
type=&#39;result&#39;&gt;
&lt;query xmlns=&#39;http://jabber.org/protocol/muc#admin&#39;&gt;
&lt;item affiliation=&#39;member&#39;
jid=&#39;hag66@shakespeare.lit&#39;
nick=&#39;thirdwitch&#39;
role=&#39;participant&#39;/&gt;
&lt;/query&gt;</pre>
<p>&lt;/iq&gt;</p>
<div class="method-source-code" id="members-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 173</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">members</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">members</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Admin</span><span class="ruby-operator">::</span><span class="ruby-constant">Members</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>)
<span class="ruby-identifier">write_with_handler</span>(<span class="ruby-identifier">members</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-say" class="method-detail ">
<div class="method-heading">
<span class="method-name">say</span><span
class="method-args">(msg, xhtml = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>&lt;message to=&#39;room@service&#39; type=&#39;groupchat&#39;&gt;</p>
<pre>&lt;body&gt;foo&lt;/body&gt;</pre>
<p>&lt;/message&gt; </p>
<div class="method-source-code" id="say-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">say</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">xhtml</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">message</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-value">:groupchat</span>)
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">xhtml</span> = <span class="ruby-identifier">xhtml</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xhtml</span>
<span class="ruby-identifier">write</span> <span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_configuration" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_configuration</span><span
class="method-args">(values, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="set_configuration-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 135</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_configuration</span>(<span class="ruby-identifier">values</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">set_configure</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Owner</span><span class="ruby-operator">::</span><span class="ruby-constant">Configure</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:set</span>, <span class="ruby-ivar">@room</span>)
<span class="ruby-identifier">set_configure</span>.<span class="ruby-identifier">data</span> = <span class="ruby-identifier">values</span>
<span class="ruby-identifier">write_with_handler</span>(<span class="ruby-identifier">set_configure</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="MultiUserChat.html#method-i-configuration-3D">configuration=</a>
</div>
</div>
<div id="method-i-set_default_configuration" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_default_configuration</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<pre>&lt;iq type=&#39;set&#39; id=&#39;purple52b37aa2&#39; to=&#39;test3@conference.macbook.local&#39;&gt;
&lt;query xmlns=&#39;http://jabber.org/protocol/muc#owner&#39;&gt;
&lt;x xmlns=&#39;jabber:x:data&#39; type=&#39;submit&#39;/&gt;&lt;/query&gt;</pre>
<p>&lt;/iq&gt;</p>
<div class="method-source-code" id="set_default_configuration-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 146</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_default_configuration</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">set_configuration</span>(<span class="ruby-value">:default</span>) <span class="ruby-keyword">do</span>
<span class="ruby-keyword">yield</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="MultiUserChat.html#method-i-unlock">unlock</a>
</div>
</div>
<div id="method-i-status-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">status=</span><span
class="method-args">(state)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>&lt;presence</p>
<pre> from=&#39;wiccarocks@shakespeare.lit/laptop&#39;
to=&#39;darkcave@chat.shakespeare.lit/oldhag&#39;&gt;
&lt;show&gt;available&lt;/show&gt;</pre>
<p>&lt;/presence&gt;</p>
<div class="method-source-code" id="status-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">status=</span>(<span class="ruby-identifier">state</span>)
<span class="ruby-identifier">status</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Presence</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">status</span>.<span class="ruby-identifier">state</span> = <span class="ruby-identifier">state</span>
<span class="ruby-identifier">status</span>.<span class="ruby-identifier">to</span> = <span class="ruby-ivar">@room</span>
<span class="ruby-identifier">write</span> <span class="ruby-identifier">status</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-subject-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">subject=</span><span
class="method-args">(body)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>&lt;message to=&#39;room@service&#39; type=&#39;groupchat&#39;&gt;</p>
<pre>&lt;subject&gt;foo&lt;/subject&gt;</pre>
<p>&lt;/message&gt; </p>
<div class="method-source-code" id="subject-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 100</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subject=</span>(<span class="ruby-identifier">body</span>)
<span class="ruby-identifier">message</span> = <span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">:groupchat</span>)
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">subject</span> = <span class="ruby-identifier">body</span>
<span class="ruby-identifier">write</span> <span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-unlock" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">unlock</span><span
class="method-args">(&amp;block)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="MultiUserChat.html#method-i-set_default_configuration">set_default_configuration</a>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">(stanza)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 179</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">stanza</span>)
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">stanza</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_with_handler" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_with_handler</span><span
class="method-args">(stanza, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="write_with_handler-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 183</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_with_handler</span>(<span class="ruby-identifier">stanza</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">write_with_handler</span>(<span class="ruby-identifier">stanza</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

99
doc/Blather/MUC.html Normal file
View file

@ -0,0 +1,99 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Blather::MUC - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
</div>
</nav>
<main role="main" aria-labelledby="module-Blather::MUC">
<h1 id="module-Blather::MUC" class="module">
module Blather::MUC
</h1>
<section class="description">
<p>Support for <a href="MUC.html"><code>MUC</code></a> Presense</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

162
doc/Blather/MUC/Admin.html Normal file
View file

@ -0,0 +1,162 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::MUC::Admin - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Blather::Stanza::Iq::Query
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::MUC::Admin">
<h1 id="class-Blather::MUC::Admin" class="class">
class Blather::MUC::Admin
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(type = nil, to = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 396</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">type</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">to</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">node</span> = <span class="ruby-keyword">super</span>(<span class="ruby-identifier">type</span>)
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">to</span> = <span class="ruby-identifier">to</span>
<span class="ruby-identifier">node</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

View file

@ -0,0 +1,220 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::MUC::Admin::Members - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../";
var index_rel_prefix = "../../../";
</script>
<script src="../../../js/navigation.js" defer></script>
<script src="../../../js/search.js" defer></script>
<script src="../../../js/search_index.js" defer></script>
<script src="../../../js/searcher.js" defer></script>
<script src="../../../js/darkfish.js" defer></script>
<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../table_of_contents.html#pages">Pages</a>
<a href="../../../table_of_contents.html#classes">Classes</a>
<a href="../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Admin.html">Blather::MUC::Admin</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-create_item">#create_item</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::MUC::Admin::Members">
<h1 id="class-Blather::MUC::Admin::Members" class="class">
class Blather::MUC::Admin::Members
</h1>
<section class="description">
<p>&lt;iq from=&#39;crone1@shakespeare.lit/desktop&#39;</p>
<pre> id=&#39;member3&#39;
to=&#39;darkcave@chat.shakespeare.lit&#39;
type=&#39;get&#39;&gt;
&lt;query xmlns=&#39;http://jabber.org/protocol/muc#admin&#39;&gt;
&lt;item affiliation=&#39;member&#39;/&gt;
&lt;/query&gt;</pre>
<p>&lt;/iq&gt;</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../Admin.html#method-c-new"><code>Blather::MUC::Admin::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 411</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">query</span> = <span class="ruby-keyword">super</span>(<span class="ruby-value">:get</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">query</span>.<span class="ruby-identifier">create_item</span>
<span class="ruby-identifier">query</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-create_item" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_item</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_item-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 417</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_item</span> <span class="ruby-comment"># @private</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_item</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:item&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-identifier">query</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">create_item</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;item&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
<span class="ruby-identifier">create_item</span>[<span class="ruby-value">:affiliation</span>] = <span class="ruby-string">&#39;member&#39;</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_item</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

623
doc/Blather/MUC/Invite.html Normal file
View file

@ -0,0 +1,623 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::MUC::Invite - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Stanza.html">Blather::Stanza</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-import">::import</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-create_invite">#create_invite</a>
<li ><a href="#method-i-create_password">#create_password</a>
<li ><a href="#method-i-create_reason">#create_reason</a>
<li ><a href="#method-i-inherit">#inherit</a>
<li ><a href="#method-i-invite_from">#invite_from</a>
<li ><a href="#method-i-invite_to">#invite_to</a>
<li ><a href="#method-i-invite_to-3D">#invite_to=</a>
<li ><a href="#method-i-password">#password</a>
<li ><a href="#method-i-password-3D">#password=</a>
<li ><a href="#method-i-reason">#reason</a>
<li ><a href="#method-i-reason-3D">#reason=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::MUC::Invite">
<h1 id="class-Blather::MUC::Invite" class="class">
class Blather::MUC::Invite
</h1>
<section class="description">
<p>&lt;x xmlns=&#39;<a href="http://jabber.org/protocol/muc#user">jabber.org/protocol/muc#user</a>&#39;&gt;</p>
<pre>&lt;invite to=&#39;jid&#39;&gt;
&lt;reason&gt;comment&lt;/reason&gt;
&lt;/invite&gt;</pre>
<p>&lt;/x&gt;</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-import" class="method-detail ">
<div class="method-heading">
<span class="method-name">import</span><span
class="method-args">(node)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="import-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 222</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">import</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">node</span>.<span class="ruby-identifier">element_name</span>).<span class="ruby-identifier">inherit</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(jid = nil, reason = nil, password = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 234</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">jid</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">password</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">invite</span> = <span class="ruby-keyword">super</span> <span class="ruby-value">:x</span>
<span class="ruby-identifier">invite</span>.<span class="ruby-identifier">invite_to</span> = <span class="ruby-identifier">jid</span>
<span class="ruby-identifier">invite</span>.<span class="ruby-identifier">reason</span> = <span class="ruby-identifier">reason</span>
<span class="ruby-identifier">invite</span>.<span class="ruby-identifier">password</span> = <span class="ruby-identifier">password</span>
<span class="ruby-identifier">invite</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-inherit" class="method-detail ">
<div class="method-heading">
<span class="method-name">inherit</span><span
class="method-args">(node)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="inherit-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 226</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inherit</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-identifier">create_invite</span>.<span class="ruby-identifier">remove</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">from</span> = <span class="ruby-identifier">node</span>[<span class="ruby-value">:from</span>]
<span class="ruby-identifier">invite</span> = <span class="ruby-identifier">node</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:x/ns:invite&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-keyword">self</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">invite</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-invite_from" class="method-detail ">
<div class="method-heading">
<span class="method-name">invite_from</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="invite_from-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 250</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invite_from</span>
<span class="ruby-identifier">create_invite</span>[<span class="ruby-value">:from</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-invite_to" class="method-detail ">
<div class="method-heading">
<span class="method-name">invite_to</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="invite_to-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 246</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invite_to</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">create_invite</span>[<span class="ruby-value">:to</span>])
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-invite_to-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">invite_to=</span><span
class="method-args">(jid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="invite_to-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 242</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invite_to=</span>(<span class="ruby-identifier">jid</span>)
<span class="ruby-identifier">create_invite</span>[<span class="ruby-value">:to</span>] = <span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">jid</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-password" class="method-detail ">
<div class="method-heading">
<span class="method-name">password</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="password-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 268</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password</span>
<span class="ruby-identifier">create_password</span>.<span class="ruby-identifier">content</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-password-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">password=</span><span
class="method-args">(password)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="password-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 263</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password=</span>(<span class="ruby-identifier">password</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">password</span>.<span class="ruby-identifier">blank?</span>
<span class="ruby-identifier">create_password</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">password</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reason" class="method-detail ">
<div class="method-heading">
<span class="method-name">reason</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="reason-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 259</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason</span>
<span class="ruby-identifier">create_reason</span>.<span class="ruby-identifier">content</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reason-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">reason=</span><span
class="method-args">(reason)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="reason-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 254</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason=</span>(<span class="ruby-identifier">reason</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">reason</span>.<span class="ruby-identifier">blank?</span>
<span class="ruby-identifier">create_reason</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">reason</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-create_invite" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_invite</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_invite-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 280</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_invite</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_invite</span> = <span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:invite&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-keyword">self</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">create_invite</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;invite&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_invite</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-create_password" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_password</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_password-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 273</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_password</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_password</span> = <span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:password&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-keyword">self</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">create_password</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;password&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_password</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-create_reason" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_reason</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_reason-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 287</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_reason</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_reason</span> = <span class="ruby-identifier">create_invite</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:reason&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">create_invite</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">create_reason</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;reason&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_reason</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

252
doc/Blather/MUC/Join.html Normal file
View file

@ -0,0 +1,252 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::MUC::Join - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Blather::XMPPNode
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-create_password">#create_password</a>
<li ><a href="#method-i-password-3D">#password=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::MUC::Join">
<h1 id="class-Blather::MUC::Join" class="class">
class Blather::MUC::Join
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(password = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 195</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">password</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">join</span> = <span class="ruby-keyword">super</span> <span class="ruby-value">:x</span>
<span class="ruby-identifier">join</span>.<span class="ruby-identifier">password</span> = <span class="ruby-identifier">password</span>
<span class="ruby-identifier">join</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-password-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">password=</span><span
class="method-args">(password)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="password-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 201</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password=</span>(<span class="ruby-identifier">password</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">password</span>.<span class="ruby-identifier">blank?</span>
<span class="ruby-identifier">create_password</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">password</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-create_password" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_password</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_password-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 207</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_password</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_password</span> = <span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:password&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-keyword">self</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">create_password</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;password&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_password</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

162
doc/Blather/MUC/Owner.html Normal file
View file

@ -0,0 +1,162 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::MUC::Owner - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Blather::Stanza::Iq::Query
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::MUC::Owner">
<h1 id="class-Blather::MUC::Owner" class="class">
class Blather::MUC::Owner
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(type = nil, to = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 304</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">type</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">to</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">node</span> = <span class="ruby-keyword">super</span>(<span class="ruby-identifier">type</span>)
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">to</span> = <span class="ruby-identifier">to</span>
<span class="ruby-identifier">node</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

View file

@ -0,0 +1,274 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::MUC::Owner::Configure - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../";
var index_rel_prefix = "../../../";
</script>
<script src="../../../js/navigation.js" defer></script>
<script src="../../../js/search.js" defer></script>
<script src="../../../js/search_index.js" defer></script>
<script src="../../../js/searcher.js" defer></script>
<script src="../../../js/darkfish.js" defer></script>
<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../table_of_contents.html#pages">Pages</a>
<a href="../../../table_of_contents.html#classes">Classes</a>
<a href="../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Owner.html">Blather::MUC::Owner</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-create_data">#create_data</a>
<li ><a href="#method-i-data">#data</a>
<li ><a href="#method-i-data-3D">#data=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::MUC::Owner::Configure">
<h1 id="class-Blather::MUC::Owner::Configure" class="class">
class Blather::MUC::Owner::Configure
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="DATA_NAMESPACE">DATA_NAMESPACE
<dd>
</dl>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-data" class="method-detail ">
<div class="method-heading">
<span class="method-name">data</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="data-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 333</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">data</span>
<span class="ruby-identifier">items</span> = <span class="ruby-identifier">create_data</span>.<span class="ruby-identifier">find</span>(<span class="ruby-string">&#39;//ns:field&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-identifier">items</span>.<span class="ruby-identifier">inject</span>({}) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span>, <span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">item</span>[<span class="ruby-value">:var</span>]
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">item</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:value&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">content</span>
<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-identifier">hash</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-data-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">data=</span><span
class="method-args">(data = :default)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="data-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 313</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">data=</span>(<span class="ruby-identifier">data</span> = <span class="ruby-value">:default</span>)
<span class="ruby-identifier">create_data</span>[<span class="ruby-value">:type</span>] = <span class="ruby-string">&#39;submit&#39;</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">blank?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">data</span> <span class="ruby-operator">==</span> <span class="ruby-value">:default</span>
<span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Invalid data format&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">create_field</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;field&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>)
<span class="ruby-identifier">create_field</span>[<span class="ruby-value">:var</span>] = <span class="ruby-identifier">key</span>
<span class="ruby-identifier">create_field_value</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;value&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>)
<span class="ruby-keyword">if</span> [<span class="ruby-constant">TrueClass</span>, <span class="ruby-constant">FalseClass</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">value</span>.<span class="ruby-identifier">class</span>)
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_field_value</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">create_field</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">create_field_value</span>
<span class="ruby-identifier">create_data</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">create_field</span>
}
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-create_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_data</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_data-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 345</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_data</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_data</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:x&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-constant">DATA_NAMESPACE</span>)
<span class="ruby-identifier">query</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">create_data</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;x&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
<span class="ruby-identifier">create_data</span>.<span class="ruby-identifier">namespace</span> = <span class="ruby-constant">DATA_NAMESPACE</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_data</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

View file

@ -0,0 +1,295 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::MUC::Owner::Destroy - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../";
var index_rel_prefix = "../../../";
</script>
<script src="../../../js/navigation.js" defer></script>
<script src="../../../js/search.js" defer></script>
<script src="../../../js/search_index.js" defer></script>
<script src="../../../js/searcher.js" defer></script>
<script src="../../../js/darkfish.js" defer></script>
<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../table_of_contents.html#pages">Pages</a>
<a href="../../../table_of_contents.html#classes">Classes</a>
<a href="../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Owner.html">Blather::MUC::Owner</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-create_destroy">#create_destroy</a>
<li ><a href="#method-i-create_reason">#create_reason</a>
<li ><a href="#method-i-reason-3D">#reason=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::MUC::Owner::Destroy">
<h1 id="class-Blather::MUC::Owner::Destroy" class="class">
class Blather::MUC::Owner::Destroy
</h1>
<section class="description">
<p>&lt;iq from=&#39;crone1@shakespeare.lit/desktop&#39;</p>
<pre> id=&#39;begone&#39;
to=&#39;heath@chat.shakespeare.lit&#39;
type=&#39;set&#39;&gt;
&lt;query xmlns=&#39;http://jabber.org/protocol/muc#owner&#39;&gt;
&lt;destroy jid=&#39;darkcave@chat.shakespeare.lit&#39;&gt;
&lt;reason&gt;Macbeth doth come.&lt;/reason&gt;
&lt;/destroy&gt;
&lt;/query&gt;</pre>
<p>&lt;/iq&gt;</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../Owner.html#method-c-new"><code>Blather::MUC::Owner::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 366</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">query</span> = <span class="ruby-keyword">super</span>(<span class="ruby-value">:set</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">query</span>.<span class="ruby-identifier">create_destroy</span>
<span class="ruby-identifier">query</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-create_destroy" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_destroy</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_destroy-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 384</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_destroy</span> <span class="ruby-comment"># @private</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_destroy</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:destroy&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-identifier">query</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">create_destroy</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;destroy&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_destroy</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-create_reason" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_reason</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_reason-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 377</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_reason</span> <span class="ruby-comment"># @private</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_reason</span> = <span class="ruby-identifier">create_destroy</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">&#39;ns:reason&#39;</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
<span class="ruby-identifier">create_destroy</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">create_reason</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;reason&#39;</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">create_reason</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reason-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">reason=</span><span
class="method-args">(reason)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="reason-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 372</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason=</span>(<span class="ruby-identifier">reason</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">reason</span>.<span class="ruby-identifier">blank?</span>
<span class="ruby-identifier">create_reason</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">reason</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

193
doc/Blather/Roster.html Normal file
View file

@ -0,0 +1,193 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::Roster - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-add">#add</a>
<li ><a href="#method-i-push">#push</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::Roster">
<h1 id="class-Blather::Roster" class="class">
class Blather::Roster
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-add" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">add</span><span
class="method-args">(elem, send = true, groups = [&quot;Buddies&quot;])</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Roster.html#method-i-push">push</a>
</div>
</div>
<div id="method-i-push" class="method-detail ">
<div class="method-heading">
<span class="method-name">push</span><span
class="method-args">(elem, send = true, groups = [&quot;Buddies&quot;])</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="push-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">push</span>(<span class="ruby-identifier">elem</span>, <span class="ruby-identifier">send</span> = <span class="ruby-keyword">true</span>, <span class="ruby-identifier">groups</span> = [<span class="ruby-string">&quot;Buddies&quot;</span>])
<span class="ruby-identifier">jid</span> = <span class="ruby-identifier">elem</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:jid</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">elem</span>.<span class="ruby-identifier">jid</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">elem</span>.<span class="ruby-identifier">jid</span> <span class="ruby-operator">:</span> <span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">elem</span>)
<span class="ruby-ivar">@items</span>[<span class="ruby-identifier">key</span>(<span class="ruby-identifier">jid</span>)] = <span class="ruby-identifier">node</span> = <span class="ruby-constant">RosterItem</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">elem</span>)
<span class="ruby-ivar">@items</span>[<span class="ruby-identifier">key</span>(<span class="ruby-identifier">jid</span>)].<span class="ruby-identifier">subscription</span> = <span class="ruby-value">:both</span>
<span class="ruby-ivar">@items</span>[<span class="ruby-identifier">key</span>(<span class="ruby-identifier">jid</span>)].<span class="ruby-identifier">groups</span> = <span class="ruby-identifier">groups</span>
<span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">node</span>.<span class="ruby-identifier">to_stanza</span>(<span class="ruby-value">:set</span>)) <span class="ruby-keyword">if</span> <span class="ruby-identifier">send</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Roster.html#method-i-add">add</a>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

104
doc/Blather/Stanza.html Normal file
View file

@ -0,0 +1,104 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::Stanza - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::Stanza">
<h1 id="class-Blather::Stanza" class="class">
class Blather::Stanza
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

View file

@ -0,0 +1,104 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::Stanza::Presence - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../../Object.html">Object</a>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::Stanza::Presence">
<h1 id="class-Blather::Stanza::Presence" class="class">
class Blather::Stanza::Presence
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

View file

@ -0,0 +1,205 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::Stanza::Presence::MUCJoin - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../";
var index_rel_prefix = "../../../";
</script>
<script src="../../../js/navigation.js" defer></script>
<script src="../../../js/search.js" defer></script>
<script src="../../../js/search_index.js" defer></script>
<script src="../../../js/searcher.js" defer></script>
<script src="../../../js/darkfish.js" defer></script>
<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../table_of_contents.html#pages">Pages</a>
<a href="../../../table_of_contents.html#classes">Classes</a>
<a href="../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Presence.html">Blather::Stanza::Presence</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-password">#password</a>
<li ><a href="#method-i-password-3D">#password=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::Stanza::Presence::MUCJoin">
<h1 id="class-Blather::Stanza::Presence::MUCJoin" class="class">
class Blather::Stanza::Presence::MUCJoin
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="MUC_NS">MUC_NS
<dd>
</dl>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-password" class="method-detail ">
<div class="method-heading">
<span class="method-name">password</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="password-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 436</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password</span>
<span class="ruby-identifier">create_muc</span>.<span class="ruby-identifier">content_from</span> <span class="ruby-value">:password</span>
<span class="ruby-identifier">create_password</span>.<span class="ruby-identifier">content</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-password-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">password=</span><span
class="method-args">(value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="password-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 441</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password=</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-identifier">create_muc</span>.<span class="ruby-identifier">set_content_for</span> <span class="ruby-value">:password</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

View file

@ -0,0 +1,344 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::Stanza::Presence::MUCUser - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../";
var index_rel_prefix = "../../../";
</script>
<script src="../../../js/navigation.js" defer></script>
<script src="../../../js/search.js" defer></script>
<script src="../../../js/search_index.js" defer></script>
<script src="../../../js/searcher.js" defer></script>
<script src="../../../js/darkfish.js" defer></script>
<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../table_of_contents.html#pages">Pages</a>
<a href="../../../table_of_contents.html#classes">Classes</a>
<a href="../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Presence.html">Blather::Stanza::Presence</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-affiliation">#affiliation</a>
<li ><a href="#method-i-affiliation-3D">#affiliation=</a>
<li ><a href="#method-i-jid">#jid</a>
<li ><a href="#method-i-jid-3D">#jid=</a>
<li ><a href="#method-i-role">#role</a>
<li ><a href="#method-i-role-3D">#role=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::Stanza::Presence::MUCUser">
<h1 id="class-Blather::Stanza::Presence::MUCUser" class="class">
class Blather::Stanza::Presence::MUCUser
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="MUC_NS">MUC_NS
<dd>
</dl>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-affiliation" class="method-detail ">
<div class="method-heading">
<span class="method-name">affiliation</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="affiliation-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 476</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">affiliation</span>
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:affiliation</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-affiliation-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">affiliation=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="affiliation-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 480</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">affiliation=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:affiliation</span>] = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-jid" class="method-detail ">
<div class="method-heading">
<span class="method-name">jid</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="jid-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 492</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">jid</span>
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:jid</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-jid-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">jid=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="jid-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 496</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">jid=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:jid</span>] = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-role" class="method-detail ">
<div class="method-heading">
<span class="method-name">role</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="role-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 484</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">role</span>
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:role</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-role-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">role=</span><span
class="method-args">(val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="role-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 488</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">role=</span>(<span class="ruby-identifier">val</span>)
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:role</span>] = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

View file

@ -0,0 +1,240 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Blather::Stanza::Presence::MUCUser::Status - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../../";
var index_rel_prefix = "../../../../";
</script>
<script src="../../../../js/navigation.js" defer></script>
<script src="../../../../js/search.js" defer></script>
<script src="../../../../js/search_index.js" defer></script>
<script src="../../../../js/searcher.js" defer></script>
<script src="../../../../js/darkfish.js" defer></script>
<link href="../../../../css/fonts.css" rel="stylesheet">
<link href="../../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../../table_of_contents.html#pages">Pages</a>
<a href="../../../../table_of_contents.html#classes">Classes</a>
<a href="../../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Blather::XMPPNode
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-code">#code</a>
<li ><a href="#method-i-code-3D">#code=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Blather::Stanza::Presence::MUCUser::Status">
<h1 id="class-Blather::Stanza::Presence::MUCUser::Status" class="class">
class Blather::Stanza::Presence::MUCUser::Status
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(code)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 457</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">code</span>)
<span class="ruby-identifier">new_node</span> = <span class="ruby-keyword">super</span> <span class="ruby-value">:status</span>
<span class="ruby-identifier">new_node</span>.<span class="ruby-identifier">code</span> = <span class="ruby-identifier">code</span>
<span class="ruby-identifier">new_node</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-code" class="method-detail ">
<div class="method-heading">
<span class="method-name">code</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="code-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 463</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">code</span>
<span class="ruby-identifier">read_attr</span> <span class="ruby-value">:code</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-code-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">code=</span><span
class="method-args">(var)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="code-3D-source">
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 467</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">code=</span>(<span class="ruby-identifier">var</span>)
<span class="ruby-identifier">write_attr</span> <span class="ruby-value">:code</span>, <span class="ruby-identifier">var</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>