<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Discorb::AuditLog::Entry::Changes — Documentation by YARD 0.9.26 </title> <link rel="stylesheet" href="../../../css/style.css" type="text/css" /> <link rel="stylesheet" href="../../../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "Discorb::AuditLog::Entry::Changes"; relpath = '../../../'; </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 class="nav_wrap"> <iframe id="nav" src="../../../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu"> <a href="../../../a_index.html">Index (C)</a> » <span class='title'><span class='object_link'><a href="../../../Discorb.html" title="Discorb (module)">Discorb</a></span></span> » <span class='title'><span class='object_link'><a href="../../AuditLog.html" title="Discorb::AuditLog (class)">AuditLog</a></span></span> » <span class='title'><span class='object_link'><a href="../Entry.html" title="Discorb::AuditLog::Entry (class)">Entry</a></span></span> » <span class="title">Changes</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../../../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Class: Discorb::AuditLog::Entry::Changes </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="../../DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></span> <ul class="fullTree"> <li>Object</li> <li class="next"><span class='object_link'><a href="../../DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></li> <li class="next">Discorb::AuditLog::Entry::Changes</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/discorb/audit_logs.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Represents the changes in an audit log entry.</p> </div> </div> <div class="tags"> </div> <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong> ⇒ Object </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute data.</p> </div></span> </li> </ul> <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="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(key) ⇒ Discorb::AuditLog::Entry::Change<sup>?</sup> </a> </span> <span class="summary_desc"><div class='inline'><p>Get a change with the given key.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#keys-instance_method" title="#keys (instance method)">#<strong>keys</strong> ⇒ Array<Symbol> </a> </span> <span class="summary_desc"><div class='inline'><p>Get keys of changes.</p> </div></span> </li> </ul> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></h3> <p class="inherited"><span class='object_link'><a href="../../DiscordModel.html#==-instance_method" title="Discorb::DiscordModel#== (method)">#==</a></span>, <span class='object_link'><a href="../../DiscordModel.html#eql%3F-instance_method" title="Discorb::DiscordModel#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="../../DiscordModel.html#hash-instance_method" title="Discorb::DiscordModel#hash (method)">#hash</a></span></p> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="data-instance_method"> #<strong>data</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute data.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 217 218 219</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 217</span> <span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span> <span class='ivar'>@data</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="[]-instance_method"> #<strong>[]</strong>(key) ⇒ <tt><span class='object_link'><a href="Change.html" title="Discorb::AuditLog::Entry::Change (class)">Discorb::AuditLog::Entry::Change</a></span></tt><sup>?</sup> </h3><div class="docstring"> <div class="discussion"> <p>Get a change with the given key.</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>key</span> <span class='type'>(<tt>Symbol</tt>)</span> — <div class='inline'><p>The key to get.</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="Change.html" title="Discorb::AuditLog::Entry::Change (class)">Discorb::AuditLog::Entry::Change</a></span></tt>)</span> — <div class='inline'><p>The change with the given key.</p> </div> </li> <li> <span class='type'>(<tt>nil</tt>)</span> — <div class='inline'><p>The change with the given key does not exist.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 250 251 252</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 250</span> <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="inspect-instance_method"> #<strong>inspect</strong> ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 229 230 231</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 229</span> <span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='ivar'>@data</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='embexpr_end'>}</span><span class='tstring_content'> changes></span><span class='tstring_end'>"</span></span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="keys-instance_method"> #<strong>keys</strong> ⇒ <tt>Array<Symbol></tt> </h3><div class="docstring"> <div class="discussion"> <p>Get keys of changes.</p> </div> </div> <div class="tags"> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array<Symbol></tt>)</span> — <div class='inline'><p>The keys of the changes.</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 238 239 240</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 238</span> <span class='kw'>def</span> <span class='id identifier rubyid_keys'>keys</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated from <a href="https://github.com/discorb-lib/discorb/tree/984483f907e152c0c374ddf559cb3057f4932bf5"><code>984483f907e152c0c374ddf559cb3057f4932bf5</code></a>, version v0.0.2, with YARD 0.9.26. </div> </div> </body> </html>