Class: Discordrb::AuditLogs::Change

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/data/audit_logs.rb

Overview

A change in a audit log entry.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#keyString (readonly)

Note:

You should check with the Discord API Documentation on what key gives out what value.

Returns the key that was changed.

Returns:

  • (String)

    the key that was changed.


170
171
172
# File 'lib/discordrb/data/audit_logs.rb', line 170

def key
  @key
end

#newString, ... (readonly) Also known as: new_value

Returns the value that was changed to.

Returns:


177
178
179
# File 'lib/discordrb/data/audit_logs.rb', line 177

def new
  @new
end

#oldString, ... (readonly) Also known as: old_value

Returns the value that was changed from.

Returns:


173
174
175
# File 'lib/discordrb/data/audit_logs.rb', line 173

def old
  @old
end

Instance Method Details

#new_afk_channelChannel?

Returns the channel that is used in the server as an AFK channel prior to this change. Only present if the key for this change is afk_channel_id.

Returns:

  • (Channel, nil)

    the channel that is used in the server as an AFK channel prior to this change. Only present if the key for this change is afk_channel_id.


212
213
214
# File 'lib/discordrb/data/audit_logs.rb', line 212

def new_afk_channel
  @bot.channel(@new, @server) if @new && @key == 'afk_channel_id'
end

#new_ownerMember, ...

Returns the member that is now the owner of the server prior to this change. Only present if the key for this change is owner_id.

Returns:

  • (Member, User, nil)

    the member that is now the owner of the server prior to this change. Only present if the key for this change is owner_id.


222
223
224
# File 'lib/discordrb/data/audit_logs.rb', line 222

def new_owner
  @server.member(@new) || @bot.user(@new) || @logs.user(@new) if @new && @key == 'owner_id'
end

#new_widget_channelChannel?

Returns the channel that is used in the server widget prior to this change. Only present if the key for this change is widget_channel_id.

Returns:

  • (Channel, nil)

    the channel that is used in the server widget prior to this change. Only present if the key for this change is widget_channel_id.


202
203
204
# File 'lib/discordrb/data/audit_logs.rb', line 202

def new_widget_channel
  @bot.channel(@new, @server) if @new && @key == 'widget_channel_id'
end

#old_afk_channelChannel?

Returns the channel that was previously used in the server as an AFK channel. Only present if the key for this change is afk_channel_id.

Returns:

  • (Channel, nil)

    the channel that was previously used in the server as an AFK channel. Only present if the key for this change is afk_channel_id.


207
208
209
# File 'lib/discordrb/data/audit_logs.rb', line 207

def old_afk_channel
  @bot.channel(@old, @server) if @old && @key == 'afk_channel_id'
end

#old_ownerMember, ...

Returns the member that used to be the owner of the server. Only present if the for key for this change is owner_id.

Returns:

  • (Member, User, nil)

    the member that used to be the owner of the server. Only present if the for key for this change is owner_id.


217
218
219
# File 'lib/discordrb/data/audit_logs.rb', line 217

def old_owner
  @server.member(@old) || @bot.user(@old) || @logs.user(@old) if @old && @key == 'owner_id'
end

#old_widget_channelChannel?

Returns the channel that was previously used in the server widget. Only present if the key for this change is widget_channel_id.

Returns:

  • (Channel, nil)

    the channel that was previously used in the server widget. Only present if the key for this change is widget_channel_id.


197
198
199
# File 'lib/discordrb/data/audit_logs.rb', line 197

def old_widget_channel
  @bot.channel(@old, @server) if @old && @key == 'widget_channel_id'
end