mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
809 lines
29 KiB
HTML
809 lines
29 KiB
HTML
<!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">(&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, &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><iq from='crone1@shakespeare.lit/desktop'</p>
|
|
|
|
<pre> id='begone'
|
|
to='heath@chat.shakespeare.lit'
|
|
type='set'>
|
|
<query xmlns='http://jabber.org/protocol/muc#owner'>
|
|
<destroy jid='darkcave@chat.shakespeare.lit'>
|
|
<reason>Macbeth doth come.</reason>
|
|
</destroy>
|
|
</query></pre>
|
|
|
|
<p></iq></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">&</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><message to='room@service'></p>
|
|
|
|
<pre><x xmlns='http://jabber.org/protocol/muc#user'>
|
|
<invite to='jid'>
|
|
<reason>comment</reason>
|
|
</invite>
|
|
</x></pre>
|
|
|
|
<p></message></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"><<</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">"#{@room}/#{@nickname}"</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">(&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p><iq from='crone1@shakespeare.lit/desktop'</p>
|
|
|
|
<pre> id='member3'
|
|
to='darkcave@chat.shakespeare.lit'
|
|
type='get'>
|
|
<query xmlns='http://jabber.org/protocol/muc#admin'>
|
|
<item affiliation='member'/>
|
|
</query></pre>
|
|
|
|
<p></iq></p>
|
|
|
|
<p><iq from='darkcave@chat.shakespeare.lit'</p>
|
|
|
|
<pre> id='member3'
|
|
to='crone1@shakespeare.lit/desktop'
|
|
type='result'>
|
|
<query xmlns='http://jabber.org/protocol/muc#admin'>
|
|
<item affiliation='member'
|
|
jid='hag66@shakespeare.lit'
|
|
nick='thirdwitch'
|
|
role='participant'/>
|
|
</query></pre>
|
|
|
|
<p></iq></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">&</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">&</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><message to='room@service' type='groupchat'></p>
|
|
|
|
<pre><body>foo</body></pre>
|
|
|
|
<p></message> </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, &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">&</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">&</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><iq type='set' id='purple52b37aa2' to='test3@conference.macbook.local'>
|
|
<query xmlns='http://jabber.org/protocol/muc#owner'>
|
|
<x xmlns='jabber:x:data' type='submit'/></query></pre>
|
|
|
|
<p></iq></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">&</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><presence</p>
|
|
|
|
<pre> from='wiccarocks@shakespeare.lit/laptop'
|
|
to='darkcave@chat.shakespeare.lit/oldhag'>
|
|
<show>available</show></pre>
|
|
|
|
<p></presence></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><message to='room@service' type='groupchat'></p>
|
|
|
|
<pre><subject>foo</subject></pre>
|
|
|
|
<p></message> </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">(&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, &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">&</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">&</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>
|
|
|