mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 11:54:29 -07:00
623 lines
21 KiB
HTML
623 lines
21 KiB
HTML
<!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><x xmlns='<a href="http://jabber.org/protocol/muc#user">jabber.org/protocol/muc#user</a>'></p>
|
|
|
|
<pre><invite to='jid'>
|
|
<reason>comment</reason>
|
|
</invite></pre>
|
|
|
|
<p></x></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">'ns:x/ns:invite'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></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"><<</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">'ns:invite'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></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"><<</span> (<span class="ruby-identifier">create_invite</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'invite'</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">'ns:password'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></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"><<</span> (<span class="ruby-identifier">create_password</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'password'</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">'ns:reason'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></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"><<</span> (<span class="ruby-identifier">create_reason</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'reason'</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>
|
|
|