Class: Discorb::AuditLog::Entry

Inherits:
DiscordModel show all
Defined in:
lib/discorb/audit_logs.rb

Overview

Represents an entry in an audit log.

Defined Under Namespace

Classes: Change, Changes

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DiscordModel

#==, #eql?

Class Attribute Details

.converts -> Object (readonly)

Returns the value of attribute converts.



235
236
237
 
# File 'lib/discorb/audit_logs.rb', line 235

def converts
  @converts
end

.events -> Object (readonly)

Returns the value of attribute events.



235
236
237
 
# File 'lib/discorb/audit_logs.rb', line 235

def events
  @events
end

Instance Attribute Details

#changes -> Discorb::AuditLog::Entry::Changes (readonly)

Returns The changes in this entry.

Returns:



110
111
112
 
# File 'lib/discorb/audit_logs.rb', line 110

def changes
  @changes
end

#id -> Discorb::Snowflake (readonly)

Returns The ID of the entry.

Returns:



53
54
55
 
# File 'lib/discorb/audit_logs.rb', line 53

def id
  @id
end

#options -> Hash{Symbol => Object} (readonly)

Note:

You can use dot notation to access the data.

Returns The optional data for this entry.

Returns:

  • (Hash{Symbol => Object}) —

    The optional data for this entry.



116
117
118
 
# File 'lib/discorb/audit_logs.rb', line 116

def options
  @options
end

#target -> Discorb::Channel, ... (readonly)

Returns The target of the entry.

Returns:



113
114
115
 
# File 'lib/discorb/audit_logs.rb', line 113

def target
  @target
end

#target_id -> Discorb::Snowflake (readonly)

Returns The ID of the target of the action.

Returns:



57
58
59
 
# File 'lib/discorb/audit_logs.rb', line 57

def target_id
  @target_id
end

#type -> Symbol (readonly)

These symbols will be used:

  • :guild_update

  • :channel_create

  • :channel_update

  • :channel_delete

  • :channel_overwrite_create

  • :channel_overwrite_update

  • :channel_overwrite_delete

  • :member_kick

  • :member_prune

  • :member_ban_add

  • :member_ban_remove

  • :member_update

  • :member_role_update

  • :member_move

  • :member_disconnect

  • :bot_add

  • :role_create

  • :role_update

  • :role_delete

  • :invite_create

  • :invite_update

  • :invite_delete

  • :webhook_create

  • :webhook_update

  • :webhook_delete

  • :emoji_create

  • :emoji_update

  • :emoji_delete

  • :message_delete

  • :message_bulk_delete

  • :message_pin

  • :message_unpin

  • :integration_create

  • :integration_update

  • :integration_delete

  • :stage_instance_create

  • :stage_instance_update

  • :stage_instance_delete

  • :sticker_create

  • :sticker_update

  • :sticker_delete

  • :guild_scheduled_event_create

  • :guild_scheduled_event_update

  • :guild_scheduled_event_delete

  • :thread_create

  • :thread_update

  • :thread_delete

Returns:

  • (Symbol) —

    The type of the entry.



108
109
110
 
# File 'lib/discorb/audit_logs.rb', line 108

def type
  @type
end

#user -> Discorb::User (readonly)

Returns The user who performed the action.

Returns:




# File 'lib/discorb/audit_logs.rb', line 118

#user_id -> Discorb::Snowflake (readonly)

Returns The ID of the user who performed the action.

Returns:



55
56
57
 
# File 'lib/discorb/audit_logs.rb', line 55

def user_id
  @user_id
end

Instance Method Details

#[](key) -> Discorb::AuditLog::Entry::Change?

Get a change with the given key.

Parameters:

  • key (Symbol) —

    The key to get.

Returns:



226
227
228
 
# File 'lib/discorb/audit_logs.rb', line 226

def [](key)
  @changes[key]
end

#inspect -> Object 



230
231
232
 
# File 'lib/discorb/audit_logs.rb', line 230

def inspect
  "#<#{self.class} #{@changes&.data&.length || "No"} changes>"
end