<!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> Class: Pubnub::Audit — 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/Audit.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 (A)</a> » <span class='title'><span class='object_link'><a href="../Pubnub.html" title="Pubnub (module)">Pubnub</a></span></span> » <span class="title">Audit</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>Class: Pubnub::Audit </h1> <dl class="box"> <dt class="r1">Inherits:</dt> <dd class="r1"> <span class="inheritName"><span class='object_link'><a href="PAM.html" title="Pubnub::PAM (class)">PAM</a></span></span> <ul class="fullTree"> <li><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></li> <li class="next"><span class='object_link'><a href="Event.html" title="Pubnub::Event (class)">Event</a></span></li> <li class="next"><span class='object_link'><a href="SingleEvent.html" title="Pubnub::SingleEvent (class)">SingleEvent</a></span></li> <li class="next"><span class='object_link'><a href="PAM.html" title="Pubnub::PAM (class)">PAM</a></span></li> <li class="next">Pubnub::Audit</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> <dt class="r2">Includes:</dt> <dd class="r2">Celluloid</dd> <dt class="r1 last">Defined in:</dt> <dd class="r1 last">lib/pubnub/events/audit.rb</dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Holds here_now functionality</p> </div> </div> <div class="tags"> </div> <h2>Instance Attribute Summary</h2> <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Event.html" title="Pubnub::Event (class)">Event</a></span></h3> <p class="inherited"><span class='object_link'><a href="Event.html#callback-instance_method" title="Pubnub::Event#callback (method)">#callback</a></span>, <span class='object_link'><a href="Event.html#channel-instance_method" title="Pubnub::Event#channel (method)">#channel</a></span>, <span class='object_link'><a href="Event.html#error_callback-instance_method" title="Pubnub::Event#error_callback (method)">#error_callback</a></span>, <span class='object_link'><a href="Event.html#group-instance_method" title="Pubnub::Event#group (method)">#group</a></span>, <span class='object_link'><a href="Event.html#idle_timeout-instance_method" title="Pubnub::Event#idle_timeout (method)">#idle_timeout</a></span>, <span class='object_link'><a href="Event.html#open_timeout-instance_method" title="Pubnub::Event#open_timeout (method)">#open_timeout</a></span>, <span class='object_link'><a href="Event.html#origin-instance_method" title="Pubnub::Event#origin (method)">#origin</a></span>, <span class='object_link'><a href="Event.html#presence_callback-instance_method" title="Pubnub::Event#presence_callback (method)">#presence_callback</a></span>, <span class='object_link'><a href="Event.html#read_timeout-instance_method" title="Pubnub::Event#read_timeout (method)">#read_timeout</a></span></p> <h2> Instance Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">- (Audit) <strong>initialize</strong>(options, app) </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p>A new instance of Audit.</p> </div></span> </li> </ul> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="PAM.html" title="Pubnub::PAM (class)">PAM</a></span></h3> <p class="inherited"><span class='object_link'><a href="PAM.html#error_envelope-instance_method" title="Pubnub::PAM#error_envelope (method)">#error_envelope</a></span>, <span class='object_link'><a href="PAM.html#format_envelopes-instance_method" title="Pubnub::PAM#format_envelopes (method)">#format_envelopes</a></span>, <span class='object_link'><a href="PAM.html#signature-instance_method" title="Pubnub::PAM#signature (method)">#signature</a></span>, <span class='object_link'><a href="PAM.html#valid_envelope-instance_method" title="Pubnub::PAM#valid_envelope (method)">#valid_envelope</a></span>, <span class='object_link'><a href="PAM.html#variables_for_signature-instance_method" title="Pubnub::PAM#variables_for_signature (method)">#variables_for_signature</a></span></p> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Event.html" title="Pubnub::Event (class)">Event</a></span></h3> <p class="inherited"><span class='object_link'><a href="Event.html#finalized%3F-instance_method" title="Pubnub::Event#finalized? (method)">#finalized?</a></span>, <span class='object_link'><a href="Event.html#fire-instance_method" title="Pubnub::Event#fire (method)">#fire</a></span>, <span class='object_link'><a href="Event.html#sync%3F-instance_method" title="Pubnub::Event#sync? (method)">#sync?</a></span>, <span class='object_link'><a href="Event.html#uri-instance_method" title="Pubnub::Event#uri (method)">#uri</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - (<tt><span class='object_link'><a href="" title="Pubnub::Audit (class)">Audit</a></span></tt>) <strong>initialize</strong>(options, app) </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Audit</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 7 8 9 10</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/pubnub/events/audit.rb', line 7</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span> <span class='ivar'>@event</span> <span class='op'>=</span> <span class='symbol'>:audit</span> <span class='kw'>super</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Tue Aug 18 16:02:33 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>