<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Pubnub
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!Pubnub.html";
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (P)</a> »
<span class="title">Pubnub</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Pubnub
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/pubnub.rb<span class="defines">,<br />
lib/pubnub/pam.rb,<br /> lib/pubnub/uuid.rb,<br /> lib/pubnub/error.rb,<br /> lib/pubnub/event.rb,<br /> lib/pubnub/heart.rb,<br /> lib/pubnub/client.rb,<br /> lib/pubnub/crypto.rb,<br /> lib/pubnub/version.rb,<br /> lib/pubnub/message.rb,<br /> lib/pubnub/envelope.rb,<br /> lib/pubnub/formatter.rb,<br /> lib/pubnub/events/time.rb,<br /> lib/pubnub/single_event.rb,<br /> lib/pubnub/events/audit.rb,<br /> lib/pubnub/events/state.rb,<br /> lib/pubnub/events/leave.rb,<br /> lib/pubnub/events/grant.rb,<br /> lib/pubnub/events/revoke.rb,<br /> lib/pubnub/client/events.rb,<br /> lib/pubnub/configuration.rb,<br /> lib/pubnub/origin_manager.rb,<br /> lib/pubnub/error_envelope.rb,<br /> lib/pubnub/events/publish.rb,<br /> lib/pubnub/events/history.rb,<br /> lib/pubnub/subscribe_event.rb,<br /> lib/pubnub/events/presence.rb,<br /> lib/pubnub/events/here_now.rb,<br /> lib/pubnub/events/heartbeat.rb,<br /> lib/pubnub/events/where_now.rb,<br /> lib/pubnub/events/subscribe.rb,<br /> lib/pubnub/validators/client.rb,<br /> lib/pubnub/validators/publish.rb,<br /> lib/pubnub/request_dispatcher.rb,<br /> lib/pubnub/client/connections.rb,<br /> lib/pubnub/validators/subscribe.rb,<br /> lib/pubnub/client/paged_history.rb,<br /> lib/pubnub/subscribe_event/adding.rb,<br /> lib/pubnub/subscribe_event/removing.rb,<br /> lib/pubnub/subscribe_event/formatter.rb,<br /> lib/pubnub/subscribe_event/heartbeat.rb,<br /> lib/pubnub/events/channel_registration.rb,<br /> lib/pubnub/validators/common_validator.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Toplevel Pubnub module.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Pubnub/Configuration.html" title="Pubnub::Configuration (module)">Configuration</a></span>, <span class='object_link'><a href="Pubnub/Formatter.html" title="Pubnub::Formatter (module)">Formatter</a></span>, <span class='object_link'><a href="Pubnub/Message.html" title="Pubnub::Message (module)">Message</a></span>, <span class='object_link'><a href="Pubnub/UUID.html" title="Pubnub::UUID (module)">UUID</a></span>, <span class='object_link'><a href="Pubnub/Validator.html" title="Pubnub::Validator (module)">Validator</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Pubnub/ArgumentError.html" title="Pubnub::ArgumentError (class)">ArgumentError</a></span>, <span class='object_link'><a href="Pubnub/Audit.html" title="Pubnub::Audit (class)">Audit</a></span>, <span class='object_link'><a href="Pubnub/ChannelRegistration.html" title="Pubnub::ChannelRegistration (class)">ChannelRegistration</a></span>, <span class='object_link'><a href="Pubnub/Client.html" title="Pubnub::Client (class)">Client</a></span>, <span class='object_link'><a href="Pubnub/Crypto.html" title="Pubnub::Crypto (class)">Crypto</a></span>, <span class='object_link'><a href="Pubnub/Envelope.html" title="Pubnub::Envelope (class)">Envelope</a></span>, <span class='object_link'><a href="Pubnub/Error.html" title="Pubnub::Error (class)">Error</a></span>, <span class='object_link'><a href="Pubnub/ErrorEnvelope.html" title="Pubnub::ErrorEnvelope (class)">ErrorEnvelope</a></span>, <span class='object_link'><a href="Pubnub/Event.html" title="Pubnub::Event (class)">Event</a></span>, <span class='object_link'><a href="Pubnub/Grant.html" title="Pubnub::Grant (class)">Grant</a></span>, <span class='object_link'><a href="Pubnub/Heart.html" title="Pubnub::Heart (class)">Heart</a></span>, <span class='object_link'><a href="Pubnub/Heartbeat.html" title="Pubnub::Heartbeat (class)">Heartbeat</a></span>, <span class='object_link'><a href="Pubnub/HereNow.html" title="Pubnub::HereNow (class)">HereNow</a></span>, <span class='object_link'><a href="Pubnub/History.html" title="Pubnub::History (class)">History</a></span>, <span class='object_link'><a href="Pubnub/InitializationError.html" title="Pubnub::InitializationError (class)">InitializationError</a></span>, <span class='object_link'><a href="Pubnub/JSONParseError.html" title="Pubnub::JSONParseError (class)">JSONParseError</a></span>, <span class='object_link'><a href="Pubnub/Leave.html" title="Pubnub::Leave (class)">Leave</a></span>, <span class='object_link'><a href="Pubnub/OriginManager.html" title="Pubnub::OriginManager (class)">OriginManager</a></span>, <span class='object_link'><a href="Pubnub/PAM.html" title="Pubnub::PAM (class)">PAM</a></span>, <span class='object_link'><a href="Pubnub/Presence.html" title="Pubnub::Presence (class)">Presence</a></span>, <span class='object_link'><a href="Pubnub/Publish.html" title="Pubnub::Publish (class)">Publish</a></span>, <span class='object_link'><a href="Pubnub/RequestDispatcher.html" title="Pubnub::RequestDispatcher (class)">RequestDispatcher</a></span>, <span class='object_link'><a href="Pubnub/RequestError.html" title="Pubnub::RequestError (class)">RequestError</a></span>, <span class='object_link'><a href="Pubnub/ResponseError.html" title="Pubnub::ResponseError (class)">ResponseError</a></span>, <span class='object_link'><a href="Pubnub/Revoke.html" title="Pubnub::Revoke (class)">Revoke</a></span>, <span class='object_link'><a href="Pubnub/SingleEvent.html" title="Pubnub::SingleEvent (class)">SingleEvent</a></span>, <span class='object_link'><a href="Pubnub/State.html" title="Pubnub::State (class)">State</a></span>, <span class='object_link'><a href="Pubnub/Subscribe.html" title="Pubnub::Subscribe (class)">Subscribe</a></span>, <span class='object_link'><a href="Pubnub/SubscribeEvent.html" title="Pubnub::SubscribeEvent (class)">SubscribeEvent</a></span>, <span class='object_link'><a href="Pubnub/Time.html" title="Pubnub::Time (class)">Time</a></span>, <span class='object_link'><a href="Pubnub/WhereNow.html" title="Pubnub::WhereNow (class)">WhereNow</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="VERSION-constant" class="">VERSION =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>4.0.0beta2</span><span class='tstring_end'>'</span></span></pre></dd>
</dl>
<h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#client-class_method" title="client (class method)">+ (Object) <strong>client</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logger-class_method" title="logger (class method)">+ (Object) <strong>logger</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute logger.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#new-class_method" title="new (class method)">+ (Object) <strong>new</strong>(options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'><p>TODO: docs.</p>
</div></span>
</li>
</ul>
<div id="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id="client=-class_method"></span>
<div class="method_details first">
<h3 class="signature first" id="client-class_method">
+ (<tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>) <strong>client</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute client</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/pubnub.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
<span class='ivar'>@client</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="logger=-class_method"></span>
<div class="method_details ">
<h3 class="signature " id="logger-class_method">
+ (<tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>) <strong>logger</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute logger</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/pubnub.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
<span class='ivar'>@logger</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="new-class_method">
+ (<tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>) <strong>new</strong>(options = {})
</h3><div class="docstring">
<div class="discussion">
<p>TODO: docs</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/pubnub.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='const'>Pubnub</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Aug 18 16:02:32 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.1.6).
</div>
</body>
</html>