Class: Discordrb::Message

Inherits:
Object
  • Object
show all
Includes:
IDObject
Defined in:
lib/discordrb/data/message.rb

Overview

A message on Discord that was sent to a text channel

Instance Attribute Summary collapse

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods included from IDObject

#==, #creation_time, synthesise

Instance Attribute Details

#attachments ⇒ Array<Attachment> (readonly)

Returns the files attached to this message.

Returns:

  • (Array<Attachment>) —

    the files attached to this message.



36
37
38
 
# File 'lib/discordrb/data/message.rb', line 36

def attachments
  @attachments
end

#author ⇒ Member, User (readonly) Also known as: user, writer

Returns the user that sent this message. (Will be a Discordrb::Member most of the time, it should only be a User for old messages when the author has left the server since then).

Returns:

  • (Member, User) —

    the user that sent this message. (Will be a Discordrb::Member most of the time, it should only be a User for old messages when the author has left the server since then)



15
16
17
 
# File 'lib/discordrb/data/message.rb', line 15

def author
  @author
end

#channel ⇒ Channel (readonly)

Returns the channel in which this message was sent.

Returns:

  • (Channel) —

    the channel in which this message was sent.



20
21
22
 
# File 'lib/discordrb/data/message.rb', line 20

def channel
  @channel
end

#components ⇒ Array<Component> (readonly)

Returns:

  • (Array<Component>) 


74
75
76
 
# File 'lib/discordrb/data/message.rb', line 74

def components
  @components
end

#content ⇒ String (readonly) Also known as: text, to_s

Returns the content of this message.

Returns:

  • (String) —

    the content of this message.



9
10
11
 
# File 'lib/discordrb/data/message.rb', line 9

def content
  @content
end

#edited ⇒ true, false (readonly) Also known as: edited?

Returns whether the message was edited or not.

Returns:

  • (true, false) —

    whether the message was edited or not.



52
53
54
 
# File 'lib/discordrb/data/message.rb', line 52

def edited
  @edited
end

#edited_timestamp ⇒ Time (readonly) Also known as: edit_timestamp

Returns the timestamp at which this message was edited. nil if the message was never edited.

Returns:

  • (Time) —

    the timestamp at which this message was edited. nil if the message was never edited.



26
27
28
 
# File 'lib/discordrb/data/message.rb', line 26

def edited_timestamp
  @edited_timestamp
end

#embeds ⇒ Array<Embed> (readonly)

Returns the embed objects contained in this message.

Returns:

  • (Array<Embed>) —

    the embed objects contained in this message.



39
40
41
 
# File 'lib/discordrb/data/message.rb', line 39

def embeds
  @embeds
end

#mention_everyone ⇒ true, false (readonly) Also known as: mention_everyone?, mentions_everyone?

Returns whether the message mentioned everyone or not.

Returns:

  • (true, false) —

    whether the message mentioned everyone or not.



56
57
58
 
# File 'lib/discordrb/data/message.rb', line 56

def mention_everyone
  @mention_everyone
end

#mentions ⇒ Array<User> (readonly)

Returns the users that were mentioned in this message.

Returns:

  • (Array<User>) —

    the users that were mentioned in this message.



30
31
32
 
# File 'lib/discordrb/data/message.rb', line 30

def mentions
  @mentions
end

#nonce ⇒ String (readonly)

Returns used for validating a message was sent.

Returns:

  • (String) —

    used for validating a message was sent.



49
50
51
 
# File 'lib/discordrb/data/message.rb', line 49

def nonce
  @nonce
end

#pinned ⇒ true, false (readonly) Also known as: pinned?

Returns whether the message is pinned or not.

Returns:

  • (true, false) —

    whether the message is pinned or not.



61
62
63
 
# File 'lib/discordrb/data/message.rb', line 61

def pinned
  @pinned
end

#reactions ⇒ Array<Reaction> (readonly)

Returns the reaction objects contained in this message.

Returns:

  • (Array<Reaction>) —

    the reaction objects contained in this message.



42
43
44
 
# File 'lib/discordrb/data/message.rb', line 42

def reactions
  @reactions
end

#role_mentions ⇒ Array<Role> (readonly)

Returns the roles that were mentioned in this message.

Returns:

  • (Array<Role>) —

    the roles that were mentioned in this message.



33
34
35
 
# File 'lib/discordrb/data/message.rb', line 33

def role_mentions
  @role_mentions
end

#server ⇒ Server? (readonly)

Returns the server in which this message was sent.

Returns:

  • (Server, nil) —

    the server in which this message was sent.



68
69
70
 
# File 'lib/discordrb/data/message.rb', line 68

def server
  @server
end

#timestamp ⇒ Time (readonly)

Returns the timestamp at which this message was sent.

Returns:

  • (Time) —

    the timestamp at which this message was sent.



23
24
25
 
# File 'lib/discordrb/data/message.rb', line 23

def timestamp
  @timestamp
end

#tts ⇒ true, false (readonly) Also known as: tts?

Returns whether the message used Text-To-Speech (TTS) or not.

Returns:

  • (true, false) —

    whether the message used Text-To-Speech (TTS) or not.



45
46
47
 
# File 'lib/discordrb/data/message.rb', line 45

def tts
  @tts
end

#type ⇒ Integer (readonly)

Returns what the type of the message is.

Returns:

  • (Integer) —

    what the type of the message is



65
66
67
 
# File 'lib/discordrb/data/message.rb', line 65

def type
  @type
end

#webhook_id ⇒ Integer? (readonly)

Returns the webhook ID that sent this message, or nil if it wasn't sent through a webhook.

Returns:

  • (Integer, nil) —

    the webhook ID that sent this message, or nil if it wasn't sent through a webhook.



71
72
73
 
# File 'lib/discordrb/data/message.rb', line 71

def webhook_id
  @webhook_id
end

Instance Method Details

#all_reaction_users(limit: 100) ⇒ Hash<String => Array<User>>

Returns a hash of all reactions to a message as keys and the users that reacted to it as values.

Examples:

Get all the users that reacted to a message for a giveaway.

giveaway_participants = message.all_reaction_users

Parameters:

  • limit (Integer) (defaults to: 100) —

    the limit of how many users to retrieve per distinct reaction emoji. nil will return all users

Returns:

  • (Hash<String => Array<User>>) —

    A hash mapping the string representation of a reaction to an array of users.



334
335
336
337
 
# File 'lib/discordrb/data/message.rb', line 334

def all_reaction_users(limit: 100)
  all_reactions = @reactions.map { |r| { r.to_s => reacted_with(r, limit: limit) } }
  all_reactions.reduce({}, :merge)
end

#await(key, attributes = {}, &block) ⇒ Object

Deprecated.

Will be changed to blocking behavior in v4.0. Use #await! instead.

Add an Await for a message with the same user and channel.

See Also:



230
231
232
 
# File 'lib/discordrb/data/message.rb', line 230

def await(key, attributes = {}, &block)
  @bot.add_await(key, Discordrb::Events::MessageEvent, { from: @author.id, in: @channel.id }.merge(attributes), &block)
end

#await!(attributes = {}, &block) ⇒ Object

Add a blocking Await for a message with the same user and channel.

See Also:



236
237
238
 
# File 'lib/discordrb/data/message.rb', line 236

def await!(attributes = {}, &block)
  @bot.add_await!(Discordrb::Events::MessageEvent, { from: @author.id, in: @channel.id }.merge(attributes), &block)
end

#await_reaction(key, attributes = {}, &block) ⇒ Object

Deprecated.

Will be changed to blocking behavior in v4.0. Use #await_reaction! instead.

Add an Await for a reaction to be added on this message.

See Also:



243
244
245
 
# File 'lib/discordrb/data/message.rb', line 243

def await_reaction(key, attributes = {}, &block)
  @bot.add_await(key, Discordrb::Events::ReactionAddEvent, { message: @id }.merge(attributes), &block)
end

#await_reaction!(attributes = {}, &block) ⇒ Object

Add a blocking Await for a reaction to be added on this message.

See Also:



249
250
251
 
# File 'lib/discordrb/data/message.rb', line 249

def await_reaction!(attributes = {}, &block)
  @bot.add_await!(Discordrb::Events::ReactionAddEvent, { message: @id }.merge(attributes), &block)
end

#buttons ⇒ Array<Components::Button>

Returns:



393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/discordrb/data/message.rb', line 393

def buttons
  results = @components.collect do |component|
    case component
    when Components::Button
      component
    when Components::ActionRow
      component.buttons
    end
  end

  results.flatten.compact
end

#chat_input_command? ⇒ true, false

Whether or not this message was of type "CHAT_INPUT_COMMAND"

Returns:

  • (true, false) 


379
380
381
 
# File 'lib/discordrb/data/message.rb', line 379

def chat_input_command?
  @type == 20
end

#create_reaction(reaction) ⇒ Object Also known as: react

Reacts to a message.

Parameters:

  • reaction (String, #to_reaction) —

    the unicode emoji or Emoji



291
292
293
294
295
 
# File 'lib/discordrb/data/message.rb', line 291

def create_reaction(reaction)
  reaction = reaction.to_reaction if reaction.respond_to?(:to_reaction)
  API::Channel.create_reaction(@bot.token, @channel.id, @id, reaction)
  nil
end

#delete(reason = nil) ⇒ Object

Deletes this message.



208
209
210
211
 
# File 'lib/discordrb/data/message.rb', line 208

def delete(reason = nil)
  API::Channel.delete_message(@bot.token, @channel.id, @id, reason)
  nil
end

#delete_all_reactions ⇒ Object

Removes all reactions from this message.



355
356
357
 
# File 'lib/discordrb/data/message.rb', line 355

def delete_all_reactions
  API::Channel.delete_all_reactions(@bot.token, @channel.id, @id)
end

#delete_own_reaction(reaction) ⇒ Object

Deletes this client's reaction on this message.

Parameters:

  • reaction (String, #to_reaction) —

    the reaction to remove



349
350
351
352
 
# File 'lib/discordrb/data/message.rb', line 349

def delete_own_reaction(reaction)
  reaction = reaction.to_reaction if reaction.respond_to?(:to_reaction)
  API::Channel.delete_own_reaction(@bot.token, @channel.id, @id, reaction)
end

#delete_reaction(user, reaction) ⇒ Object

Deletes a reaction made by a user on this message.

Parameters:

  • user (User, String, Integer) —

    the user or user ID who used this reaction

  • reaction (String, #to_reaction) —

    the reaction to remove



342
343
344
345
 
# File 'lib/discordrb/data/message.rb', line 342

def delete_reaction(user, reaction)
  reaction = reaction.to_reaction if reaction.respond_to?(:to_reaction)
  API::Channel.delete_user_reaction(@bot.token, @channel.id, @id, reaction, user.resolve_id)
end

#edit(new_content, new_embeds = nil, new_components = nil) ⇒ Message

Edits this message to have the specified content instead. You can only edit your own messages.

Parameters:

  • new_content (String) —

    the new content the message should have.

  • new_embeds (Hash, Discordrb::Webhooks::Embed, Array<Hash>, Array<Discordrb::Webhooks::Embed>, nil) (defaults to: nil) —

    The new embeds the message should have. If nil the message will be changed to have no embeds.

  • new_components (View, Array<Hash>) (defaults to: nil) —

    The new components the message should have. If nil the message will be changed to have no components.

Returns:

  • (Message) —

    the resulting message.



199
200
201
202
203
204
205
 
# File 'lib/discordrb/data/message.rb', line 199

def edit(new_content, new_embeds = nil, new_components = nil)
  new_embeds = (new_embeds.instance_of?(Array) ? new_embeds.map(&:to_hash) : [new_embeds&.to_hash]).compact
  new_components = new_components&.to_a || []

  response = API::Channel.edit_message(@bot.token, @channel.id, @id, new_content, [], new_embeds, new_components)
  Message.new(JSON.parse(response), @bot)
end

#emoji ⇒ Array<Emoji>

Returns the emotes that were used/mentioned in this message.

Returns:

  • (Array<Emoji>) —

    the emotes that were used/mentioned in this message.



264
265
266
267
268
269
 
# File 'lib/discordrb/data/message.rb', line 264

def emoji
  return if @content.nil?
  return @emoji unless @emoji.empty?

  @emoji = @bot.parse_mentions(@content).select { |el| el.is_a? Discordrb::Emoji }
end

#emoji? ⇒ true, false

Check if any emoji were used in this message.

Returns:

  • (true, false) —

    whether or not any emoji were used



273
274
275
 
# File 'lib/discordrb/data/message.rb', line 273

def emoji?
  emoji&.empty?
end

#from_bot? ⇒ true, false

Returns whether this message was sent by the current Bot.

Returns:

  • (true, false) —

    whether this message was sent by the current Bot.



254
255
256
 
# File 'lib/discordrb/data/message.rb', line 254

def from_bot?
  @author&.current_bot?
end

#inspect ⇒ Object

The inspect method is overwritten to give more useful output



360
361
362
 
# File 'lib/discordrb/data/message.rb', line 360

def inspect
  "<Message content=\"#{@content}\" id=#{@id} timestamp=#{@timestamp} author=#{@author} channel=#{@channel}>"
end

#link ⇒ String Also known as: jump_link

Returns a URL that a user can use to navigate to this message in the client.

Returns:

  • (String) —

    a URL that a user can use to navigate to this message in the client



365
366
367
 
# File 'lib/discordrb/data/message.rb', line 365

def link
  "https://discord.com/channels/#{@server&.id || '@me'}/#{@channel.id}/#{@id}"
end

#my_reactions ⇒ Array<Reaction>

Returns the reactions made by the current bot or user.

Returns:



285
286
287
 
# File 'lib/discordrb/data/message.rb', line 285

def my_reactions
  @reactions.select(&:me)
end

#pin(reason = nil) ⇒ Object

Pins this message



214
215
216
217
218
 
# File 'lib/discordrb/data/message.rb', line 214

def pin(reason = nil)
  API::Channel.pin_message(@bot.token, @channel.id, @id, reason)
  @pinned = true
  nil
end

#reacted_with(reaction, limit: 100) ⇒ Array<User>

Returns the list of users who reacted with a certain reaction.

Examples:

Get all the users that reacted with a thumbs up.

thumbs_up_reactions = message.reacted_with("\u{1F44D}")

Parameters:

  • reaction (String, #to_reaction) —

    the unicode emoji or Emoji

  • limit (Integer) (defaults to: 100) —

    the limit of how many users to retrieve. nil will return all users

Returns:

  • (Array<User>) —

    the users who used this reaction



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/discordrb/data/message.rb', line 305

def reacted_with(reaction, limit: 100)
  reaction = reaction.to_reaction if reaction.respond_to?(:to_reaction)
  reaction = reaction.to_s if reaction.respond_to?(:to_s)

  get_reactions = proc do |fetch_limit, after_id = nil|
    resp = API::Channel.get_reactions(@bot.token, @channel.id, @id, reaction, nil, after_id, fetch_limit)
    return JSON.parse(resp).map { |d| User.new(d, @bot) }
  end

  # Can be done without pagination
  return get_reactions.call(limit) if limit && limit <= 100

  paginator = Paginator.new(limit, :down) do |last_page|
    if last_page && last_page.count < 100
      []
    else
      get_reactions.call(100, last_page&.last&.id)
    end
  end

  paginator.to_a
end

#reactions? ⇒ true, false

Check if any reactions were used in this message.

Returns:

  • (true, false) —

    whether or not this message has reactions



279
280
281
 
# File 'lib/discordrb/data/message.rb', line 279

def reactions?
  !@reactions.empty?
end

#referenced_message ⇒ Message?

Returns the Message this Message was sent in reply to.

Returns:

  • (Message, nil) —

    the Message this Message was sent in reply to.



384
385
386
387
388
389
390
 
# File 'lib/discordrb/data/message.rb', line 384

def referenced_message
  return @referenced_message if @referenced_message
  return nil unless @message_reference

  referenced_channel = @bot.channel(@message_reference['channel_id'])
  @referenced_message = referenced_channel.message(@message_reference['message_id'])
end

#reply(content) ⇒ Message

Deprecated.

Please use #respond.

Replies to this message with the specified content.

Parameters:

  • content (String) —

    The content to send. Should not be longer than 2000 characters or it will result in an error.

Returns:

  • (Message) —

    the message that was sent.

See Also:



167
168
169
 
# File 'lib/discordrb/data/message.rb', line 167

def reply(content)
  @channel.send_message(content)
end

#reply!(content, tts: false, embed: nil, attachments: nil, allowed_mentions: {}, mention_user: false, components: nil) ⇒ Message

Responds to this message as an inline reply.

Parameters:

  • content (String) —

    The content to send. Should not be longer than 2000 characters or it will result in an error.

  • tts (true, false) (defaults to: false) —

    Whether or not this message should be sent using Discord text-to-speech.

  • embed (Hash, Discordrb::Webhooks::Embed, nil) (defaults to: nil) —

    The rich embed to append to this message.

  • attachments (Array<File>) (defaults to: nil) —

    Files that can be referenced in embeds via attachment://file.png

  • allowed_mentions (Hash, Discordrb::AllowedMentions, false, nil) (defaults to: {}) —

    Mentions that are allowed to ping on this message. false disables all pings

  • mention_user (true, false) (defaults to: false) —

    Whether the user that is being replied to should be pinged by the reply.

  • components (View, Array<Hash>) (defaults to: nil) —

    Interaction components to associate with this message.

Returns:

  • (Message) —

    the message that was sent.



180
181
182
183
184
185
186
 
# File 'lib/discordrb/data/message.rb', line 180

def reply!(content, tts: false, embed: nil, attachments: nil, allowed_mentions: {}, mention_user: false, components: nil)
  allowed_mentions = { parse: [] } if allowed_mentions == false
  allowed_mentions = allowed_mentions.to_hash.transform_keys(&:to_sym)
  allowed_mentions[:replied_user] = mention_user

  respond(content, tts, embed, attachments, allowed_mentions, self, components)
end

#reply? ⇒ true, false

Whether or not this message was sent in reply to another message

Returns:

  • (true, false) 


373
374
375
 
# File 'lib/discordrb/data/message.rb', line 373

def reply?
  !@referenced_message.nil?
end

#respond(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil) ⇒ Message

Sends a message to this channel.

Parameters:

  • content (String) —

    The content to send. Should not be longer than 2000 characters or it will result in an error.

  • tts (true, false) (defaults to: false) —

    Whether or not this message should be sent using Discord text-to-speech.

  • embed (Hash, Discordrb::Webhooks::Embed, nil) (defaults to: nil) —

    The rich embed to append to this message.

  • attachments (Array<File>) (defaults to: nil) —

    Files that can be referenced in embeds via attachment://file.png

  • allowed_mentions (Hash, Discordrb::AllowedMentions, false, nil) (defaults to: nil) —

    Mentions that are allowed to ping on this message. false disables all pings

  • message_reference (Message, String, Integer, nil) (defaults to: nil) —

    The message, or message ID, to reply to if any.

  • components (View, Array<Hash>) (defaults to: nil) —

    Interaction components to associate with this message.

Returns:

  • (Message) —

    the message that was sent.



189
190
191
 
# File 'lib/discordrb/data/message.rb', line 189

def respond(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil)
  @channel.send_message(content, tts, embed, attachments, allowed_mentions, message_reference, components)
end

#to_message ⇒ Discordrb::Message Also known as: message

to_message -> self or message

Returns:



408
409
410
 
# File 'lib/discordrb/data/message.rb', line 408

def to_message
  self
end

#unpin(reason = nil) ⇒ Object

Unpins this message



221
222
223
224
225
 
# File 'lib/discordrb/data/message.rb', line 221

def unpin(reason = nil)
  API::Channel.unpin_message(@bot.token, @channel.id, @id, reason)
  @pinned = false
  nil
end

#webhook? ⇒ true, false

Returns whether this message has been sent over a webhook.

Returns:

  • (true, false) —

    whether this message has been sent over a webhook.



259
260
261
 
# File 'lib/discordrb/data/message.rb', line 259

def webhook?
  !@webhook_id.nil?
end