Class: Discorb::Gateway::MessageUpdateEvent

Inherits:
GatewayEvent show all
Defined in:
lib/discorb/gateway.rb

Overview

Represents a MESSAGE_UPDATE event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, data, before, after) -> MessageUpdateEvent

Returns a new instance of MessageUpdateEvent.



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/discorb/gateway.rb', line 240

def initialize(client, data, before, after)
  @client = client
  @data = data
  @before = before
  @after = after
  @id = Snowflake.new(data[:id])
  @channel_id = Snowflake.new(data[:channel_id])
  @guild_id = Snowflake.new(data[:guild_id]) if data.key?(:guild_id)
  @content = data[:content]
  @timestamp = Time.iso8601(data[:edited_timestamp])
  @mention_everyone = data[:mention_everyone]
  @mention_roles = data[:mention_roles].map { |r| guild.roles[r] } if data.key?(:mention_roles)
  @attachments = data[:attachments].map { |a| Attachment.new(a) } if data.key?(:attachments)
  @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.new(data: e) } : [] if data.key?(:embeds)
end

Instance Attribute Details

#after -> Discorb::Message (readonly)

Returns The message after update.

Returns:



212
213
214
 
# File 'lib/discorb/gateway.rb', line 212

def after
  @after
end

#attachments -> Array<Discorb::Attachment> (readonly)

Returns The attachments in the message.

Returns:



229
230
231
 
# File 'lib/discorb/gateway.rb', line 229

def attachments
  @attachments
end

#before -> Discorb::Message (readonly)

Returns The message before update.

Returns:



210
211
212
 
# File 'lib/discorb/gateway.rb', line 210

def before
  @before
end

#channel -> nil, Discorb::Channel (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Channel) —

    The channel the message was sent in.



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/discorb/gateway.rb', line 240

def initialize(client, data, before, after)
  @client = client
  @data = data
  @before = before
  @after = after
  @id = Snowflake.new(data[:id])
  @channel_id = Snowflake.new(data[:channel_id])
  @guild_id = Snowflake.new(data[:guild_id]) if data.key?(:guild_id)
  @content = data[:content]
  @timestamp = Time.iso8601(data[:edited_timestamp])
  @mention_everyone = data[:mention_everyone]
  @mention_roles = data[:mention_roles].map { |r| guild.roles[r] } if data.key?(:mention_roles)
  @attachments = data[:attachments].map { |a| Attachment.new(a) } if data.key?(:attachments)
  @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.new(data: e) } : [] if data.key?(:embeds)
end

#channel_id -> Discorb::Snowflake (readonly)

Returns The ID of the channel the message was sent in.

Returns:



216
217
218
 
# File 'lib/discorb/gateway.rb', line 216

def channel_id
  @channel_id
end

#content -> String (readonly)

Returns The new content of the message.

Returns:

  • (String) —

    The new content of the message.



220
221
222
 
# File 'lib/discorb/gateway.rb', line 220

def content
  @content
end

#embeds -> Array<Discorb::Embed> (readonly)

Returns The embeds in the message.

Returns:



231
232
233
 
# File 'lib/discorb/gateway.rb', line 231

def embeds
  @embeds
end

#guild -> nil, Discorb::Guild (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Guild) —

    The guild the message was sent in.



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/discorb/gateway.rb', line 240

def initialize(client, data, before, after)
  @client = client
  @data = data
  @before = before
  @after = after
  @id = Snowflake.new(data[:id])
  @channel_id = Snowflake.new(data[:channel_id])
  @guild_id = Snowflake.new(data[:guild_id]) if data.key?(:guild_id)
  @content = data[:content]
  @timestamp = Time.iso8601(data[:edited_timestamp])
  @mention_everyone = data[:mention_everyone]
  @mention_roles = data[:mention_roles].map { |r| guild.roles[r] } if data.key?(:mention_roles)
  @attachments = data[:attachments].map { |a| Attachment.new(a) } if data.key?(:attachments)
  @embeds = data[:embeds] ? data[:embeds].map { |e| Embed.new(data: e) } : [] if data.key?(:embeds)
end

#guild_id -> Discorb::Snowflake (readonly)

Returns The ID of the guild the message was sent in.

Returns:



218
219
220
 
# File 'lib/discorb/gateway.rb', line 218

def guild_id
  @guild_id
end

#id -> Discorb::Snowflake (readonly)

Returns The ID of the message.

Returns:



214
215
216
 
# File 'lib/discorb/gateway.rb', line 214

def id
  @id
end

#mention_everyone -> Boolean (readonly)

Returns Whether the message pings @everyone.

Returns:

  • (Boolean) —

    Whether the message pings @everyone.



224
225
226
 
# File 'lib/discorb/gateway.rb', line 224

def mention_everyone
  @mention_everyone
end

#mention_roles -> nil, Array<Discorb::Role> (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Array<Discorb::Role>) —

    The roles mentioned in the message.



227
228
229
 
# File 'lib/discorb/gateway.rb', line 227

def mention_roles
  @mention_roles
end

#timestamp -> Time (readonly)

Returns The time the message was edited.

Returns:

  • (Time) —

    The time the message was edited.



222
223
224
 
# File 'lib/discorb/gateway.rb', line 222

def timestamp
  @timestamp
end

Instance Method Details

#fetch_message -> Discorb::Message

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Fetch the message.

Returns:

Raises:



269
270
271
272
273
 
# File 'lib/discorb/gateway.rb', line 269

def fetch_message
  Async do
    channel.fetch_message(@id).wait
  end
end