<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::AuditLog::Entry
— 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";
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 (E)</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">Entry</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
</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</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 an entry in an audit log.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Entry/Change.html" title="Discorb::AuditLog::Entry::Change (class)">Change</a></span>, <span class='object_link'><a href="Entry/Changes.html" title="Discorb::AuditLog::Entry::Changes (class)">Changes</a></span>
</p>
<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="#converts-class_method" title="converts (class method)">.<strong>converts</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute converts.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#events-class_method" title="events (class method)">.<strong>events</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute events.</p>
</div></span>
</li>
</ul>
<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="#changes-instance_method" title="#changes (instance method)">#<strong>changes</strong> ⇒ Discorb::AuditLog::Entry::Changes </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The changes in this entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ Discorb::Snowflake </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The ID of the entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong> ⇒ Hash{Symbol => Object} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The optional data for this entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#target-instance_method" title="#target (instance method)">#<strong>target</strong> ⇒ Discorb::Channel, ... </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The target of the entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#target_id-instance_method" title="#target_id (instance method)">#<strong>target_id</strong> ⇒ Discorb::Snowflake </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The ID of the target of the action.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> ⇒ Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>These symbols will be used:.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user-instance_method" title="#user (instance method)">#<strong>user</strong> ⇒ Discorb::User </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The user who performed the action.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_id-instance_method" title="#user_id (instance method)">#<strong>user_id</strong> ⇒ Discorb::Snowflake </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The ID of the user who performed the action.</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>
</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="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="converts-class_method">
.<strong>converts</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute converts.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
210
211
212</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 210</span>
<span class='kw'>def</span> <span class='id identifier rubyid_converts'>converts</span>
<span class='ivar'>@converts</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="events-class_method">
.<strong>events</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute events.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
210
211
212</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 210</span>
<span class='kw'>def</span> <span class='id identifier rubyid_events'>events</span>
<span class='ivar'>@events</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<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="changes-instance_method">
#<strong>changes</strong> ⇒ <tt><span class='object_link'><a href="Entry/Changes.html" title="Discorb::AuditLog::Entry::Changes (class)">Discorb::AuditLog::Entry::Changes</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The changes in this entry.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Entry/Changes.html" title="Discorb::AuditLog::Entry::Changes (class)">Discorb::AuditLog::Entry::Changes</a></span></tt>)</span>
—
<div class='inline'><p>The changes in this entry.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 98</span>
<span class='kw'>def</span> <span class='id identifier rubyid_changes'>changes</span>
<span class='ivar'>@changes</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
#<strong>id</strong> ⇒ <tt><span class='object_link'><a href="../Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The ID of the entry.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt>)</span>
—
<div class='inline'><p>The ID of the entry.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="options-instance_method">
#<strong>options</strong> ⇒ <tt>Hash{Symbol => Object}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>You can use dot notation to access the data.</p>
</div>
</div>
<p>Returns The optional data for this entry.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash{Symbol => Object}</tt>)</span>
—
<div class='inline'><p>The optional data for this entry.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
103
104
105</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 103</span>
<span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
<span class='ivar'>@options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="target-instance_method">
#<strong>target</strong> ⇒ <tt><span class='object_link'><a href="../Channel.html" title="Discorb::Channel (class)">Discorb::Channel</a></span></tt>, ... <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The target of the entry.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Channel.html" title="Discorb::Channel (class)">Discorb::Channel</a></span></tt>, <tt><span class='object_link'><a href="../Role.html" title="Discorb::Role (class)">Discorb::Role</a></span></tt>, <tt><span class='object_link'><a href="../Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt>, <tt><span class='object_link'><a href="../Guild.html" title="Discorb::Guild (class)">Discorb::Guild</a></span></tt>, <tt><span class='object_link'><a href="../Message.html" title="Discorb::Message (class)">Discorb::Message</a></span></tt>)</span>
—
<div class='inline'><p>The target of the entry.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
100
101
102</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 100</span>
<span class='kw'>def</span> <span class='id identifier rubyid_target'>target</span>
<span class='ivar'>@target</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="target_id-instance_method">
#<strong>target_id</strong> ⇒ <tt><span class='object_link'><a href="../Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The ID of the target of the action.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt>)</span>
—
<div class='inline'><p>The ID of the target of the action.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_target_id'>target_id</span>
<span class='ivar'>@target_id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="type-instance_method">
#<strong>type</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>These symbols will be used:</p>
<ul>
<li><code>:guild_update</code></li>
<li><code>:channel_create</code></li>
<li><code>:channel_update</code></li>
<li><code>:channel_delete</code></li>
<li><code>:channel_overwrite_create</code></li>
<li><code>:channel_overwrite_update</code></li>
<li><code>:channel_overwrite_delete</code></li>
<li><code>:member_kick</code></li>
<li><code>:member_prune</code></li>
<li><code>:member_ban_add</code></li>
<li><code>:member_ban_remove</code></li>
<li><code>:member_update</code></li>
<li><code>:member_role_update</code></li>
<li><code>:member_move</code></li>
<li><code>:member_disconnect</code></li>
<li><code>:bot_add</code></li>
<li><code>:role_create</code></li>
<li><code>:role_update</code></li>
<li><code>:role_delete</code></li>
<li><code>:invite_create</code></li>
<li><code>:invite_update</code></li>
<li><code>:invite_delete</code></li>
<li><code>:webhook_create</code></li>
<li><code>:webhook_update</code></li>
<li><code>:webhook_delete</code></li>
<li><code>:emoji_create</code></li>
<li><code>:emoji_update</code></li>
<li><code>:emoji_delete</code></li>
<li><code>:message_delete</code></li>
<li><code>:message_bulk_delete</code></li>
<li><code>:message_pin</code></li>
<li><code>:message_unpin</code></li>
<li><code>:integration_create</code></li>
<li><code>:integration_update</code></li>
<li><code>:integration_delete</code></li>
<li><code>:stage_instance_create</code></li>
<li><code>:stage_instance_update</code></li>
<li><code>:stage_instance_delete</code></li>
<li><code>:sticker_create</code></li>
<li><code>:sticker_update</code></li>
<li><code>:sticker_delete</code></li>
<li><code>:thread_create</code></li>
<li><code>:thread_update</code></li>
<li><code>:thread_delete</code></li>
</ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>The type of the entry.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
96
97
98</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 96</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@type</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="user-instance_method">
#<strong>user</strong> ⇒ <tt><span class='object_link'><a href="../User.html" title="Discorb::User (class)">Discorb::User</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The user who performed the action.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../User.html" title="Discorb::User (class)">Discorb::User</a></span></tt>)</span>
—
<div class='inline'><p>The user who performed the action.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 105</span>
</pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="user_id-instance_method">
#<strong>user_id</strong> ⇒ <tt><span class='object_link'><a href="../Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The ID of the user who performed the action.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt>)</span>
—
<div class='inline'><p>The ID of the user who performed the action.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user_id'>user_id</span>
<span class='ivar'>@user_id</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="Entry/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="Entry/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">
201
202
203</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 201</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'>@changes</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</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">
205
206
207</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/audit_logs.rb', line 205</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'>@changes</span><span class='op'>&.</span><span class='id identifier rubyid_data'>data</span><span class='op'>&.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>No</span><span class='tstring_end'>'</span></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>
</div>
<div id="footer">
Generated from <a href="https://github.com/discorb-lib/discorb/tree/f2efd3528ec4c4b6b15b2788f8ff8b788eb88cdb"><code>f2efd3528ec4c4b6b15b2788f8ff8b788eb88cdb</code></a>, version v0.0.4, with YARD 0.9.26.
</div>
</div>
</body>
</html>