Class: Discordrb::Message
- Inherits:
-
Object
- Object
- Discordrb::Message
- 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
-
#attachments ⇒ Array<Attachment>
readonly
The files attached to this message.
-
#author ⇒ Member, User
(also: #user, #writer)
readonly
The user that sent this message.
-
#channel ⇒ Channel
readonly
The channel in which this message was sent.
-
#components ⇒ Array<Component>
readonly
Interaction components for this message.
-
#content ⇒ String
(also: #text, #to_s)
readonly
The content of this message.
-
#edited ⇒ true, false
(also: #edited?)
readonly
Whether the message was edited or not.
-
#edited_timestamp ⇒ Time
(also: #edit_timestamp)
readonly
The timestamp at which this message was edited.
-
#embeds ⇒ Array<Embed>
readonly
The embed objects contained in this message.
-
#flags ⇒ Integer
readonly
Flags set on the message.
-
#mention_everyone ⇒ true, false
(also: #mention_everyone?, #mentions_everyone?)
readonly
Whether the message mentioned everyone or not.
-
#mentions ⇒ Array<User>
readonly
The users that were mentioned in this message.
-
#nonce ⇒ String
readonly
Used for validating a message was sent.
-
#pinned ⇒ true, false
(also: #pinned?)
readonly
Whether the message is pinned or not.
-
#reactions ⇒ Array<Reaction>
readonly
The reaction objects contained in this message.
-
#role_mentions ⇒ Array<Role>
readonly
The roles that were mentioned in this message.
-
#server ⇒ Server?
readonly
The server in which this message was sent.
-
#thread ⇒ Channel?
readonly
The thread that was started from this message, or nil.
-
#timestamp ⇒ Time
readonly
The timestamp at which this message was sent.
-
#tts ⇒ true, false
(also: #tts?)
readonly
Whether the message used Text-To-Speech (TTS) or not.
-
#type ⇒ Integer
readonly
What the type of the message is.
-
#webhook_id ⇒ Integer?
readonly
The webhook ID that sent this message, or
nil
if it wasn't sent through a webhook.
Attributes included from IDObject
Instance Method Summary collapse
-
#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.
-
#await(key, attributes = {}, &block) ⇒ Object
deprecated
Deprecated.
Will be changed to blocking behavior in v4.0. Use #await! instead.
-
#await!(attributes = {}, &block) ⇒ Object
Add a blocking Await for a message with the same user and channel.
-
#await_reaction(key, attributes = {}, &block) ⇒ Object
deprecated
Deprecated.
Will be changed to blocking behavior in v4.0. Use #await_reaction! instead.
-
#await_reaction!(attributes = {}, &block) ⇒ Object
Add a blocking Await for a reaction to be added on this message.
- #buttons ⇒ Array<Components::Button>
-
#chat_input_command? ⇒ true, false
Whether or not this message was of type "CHAT_INPUT_COMMAND".
-
#create_reaction(reaction) ⇒ Object
(also: #react)
Reacts to a message.
-
#crosspost ⇒ Object
Crossposts a message in a news channel.
-
#delete(reason = nil) ⇒ Object
Deletes this message.
-
#delete_all_reactions ⇒ Object
Removes all reactions from this message.
-
#delete_own_reaction(reaction) ⇒ Object
Deletes this client's reaction on this message.
-
#delete_reaction(user, reaction) ⇒ Object
Deletes a reaction made by a user on this message.
-
#edit(new_content, new_embeds = nil, new_components = nil, flags = 0) ⇒ Message
Edits this message to have the specified content instead.
-
#emoji ⇒ Array<Emoji>
The emotes that were used/mentioned in this message.
-
#emoji? ⇒ true, false
Check if any emoji were used in this message.
-
#from_bot? ⇒ true, false
Whether this message was sent by the current Bot.
-
#inspect ⇒ Object
The inspect method is overwritten to give more useful output.
-
#link ⇒ String
(also: #jump_link)
A URL that a user can use to navigate to this message in the client.
-
#my_reactions ⇒ Array<Reaction>
Returns the reactions made by the current bot or user.
-
#pin(reason = nil) ⇒ Object
Pins this message.
-
#reacted_with(reaction, limit: 100) ⇒ Array<User>
Returns the list of users who reacted with a certain reaction.
-
#reactions? ⇒ true, false
Check if any reactions were used in this message.
-
#referenced_message ⇒ Message?
The Message this Message was sent in reply to.
-
#reply(content) ⇒ Message
deprecated
Deprecated.
Please use #respond.
-
#reply!(content, tts: false, embed: nil, attachments: nil, allowed_mentions: {}, mention_user: false, components: nil, flags: 0) ⇒ Message
Responds to this message as an inline reply.
-
#reply? ⇒ true, false
Whether or not this message was sent in reply to another message.
-
#respond(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0) ⇒ Message
Sends a message to this channel.
-
#suppress_embeds ⇒ Message
Removes embeds from the message.
-
#to_message ⇒ Discordrb::Message
(also: #message)
to_message -> self or message.
-
#unpin(reason = nil) ⇒ Object
Unpins this message.
-
#webhook? ⇒ true, false
Whether this message has been sent over a webhook.
Methods included from IDObject
#==, #creation_time, synthesise
Instance Attribute Details
#attachments ⇒ Array<Attachment> (readonly)
Returns the files attached to this message.
36 37 38 |
# File 'lib/discordrb/data/message.rb', line 36 def @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).
15 16 17 |
# File 'lib/discordrb/data/message.rb', line 15 def @author end |
#channel ⇒ Channel (readonly)
Returns 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 Interaction components for this message.
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.
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.
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.
26 27 28 |
# File 'lib/discordrb/data/message.rb', line 26 def @edited_timestamp end |
#embeds ⇒ Array<Embed> (readonly)
Returns the embed objects contained in this message.
39 40 41 |
# File 'lib/discordrb/data/message.rb', line 39 def @embeds end |
#flags ⇒ Integer (readonly)
Returns flags set on the message.
77 78 79 |
# File 'lib/discordrb/data/message.rb', line 77 def flags @flags end |
#mention_everyone ⇒ true, false (readonly) Also known as: mention_everyone?, mentions_everyone?
Returns 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.
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.
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.
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.
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.
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.
68 69 70 |
# File 'lib/discordrb/data/message.rb', line 68 def server @server end |
#thread ⇒ Channel? (readonly)
Returns The thread that was started from this message, or nil.
80 81 82 |
# File 'lib/discordrb/data/message.rb', line 80 def thread @thread end |
#timestamp ⇒ Time (readonly)
Returns the timestamp at which this message was sent.
23 24 25 |
# File 'lib/discordrb/data/message.rb', line 23 def @timestamp end |
#tts ⇒ true, false (readonly) Also known as: tts?
Returns 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.
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.
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.
360 361 362 363 |
# File 'lib/discordrb/data/message.rb', line 360 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
248 249 250 |
# File 'lib/discordrb/data/message.rb', line 248 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.
254 255 256 |
# File 'lib/discordrb/data/message.rb', line 254 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
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.
261 262 263 |
# File 'lib/discordrb/data/message.rb', line 261 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.
267 268 269 |
# File 'lib/discordrb/data/message.rb', line 267 def await_reaction!(attributes = {}, &block) @bot.add_await!(Discordrb::Events::ReactionAddEvent, { message: @id }.merge(attributes), &block) end |
#buttons ⇒ Array<Components::Button>
419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'lib/discordrb/data/message.rb', line 419 def results = @components.collect do |component| case component when Components::Button component when Components::ActionRow component. end end results.flatten.compact end |
#chat_input_command? ⇒ true, false
Whether or not this message was of type "CHAT_INPUT_COMMAND"
405 406 407 |
# File 'lib/discordrb/data/message.rb', line 405 def chat_input_command? @type == 20 end |
#create_reaction(reaction) ⇒ Object Also known as: react
Reacts to a message.
317 318 319 320 321 |
# File 'lib/discordrb/data/message.rb', line 317 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 |
#crosspost ⇒ Object
Crossposts a message in a news channel.
240 241 242 243 |
# File 'lib/discordrb/data/message.rb', line 240 def crosspost response = API::Channel.(@bot.token, @channel.id, @id) Message.new(JSON.parse(response), @bot) end |
#delete(reason = nil) ⇒ Object
Deletes this message.
220 221 222 223 |
# File 'lib/discordrb/data/message.rb', line 220 def delete(reason = nil) API::Channel.(@bot.token, @channel.id, @id, reason) nil end |
#delete_all_reactions ⇒ Object
Removes all reactions from this message.
381 382 383 |
# File 'lib/discordrb/data/message.rb', line 381 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.
375 376 377 378 |
# File 'lib/discordrb/data/message.rb', line 375 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.
368 369 370 371 |
# File 'lib/discordrb/data/message.rb', line 368 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, flags = 0) ⇒ Message
Edits this message to have the specified content instead. You can only edit your own messages.
211 212 213 214 215 216 217 |
# File 'lib/discordrb/data/message.rb', line 211 def edit(new_content, = nil, new_components = nil, flags = 0) = (.instance_of?(Array) ? .map(&:to_hash) : [&.to_hash]).compact new_components = new_components.to_a response = API::Channel.(@bot.token, @channel.id, @id, new_content, [], , new_components, flags) Message.new(JSON.parse(response), @bot) end |
#emoji ⇒ Array<Emoji>
Returns the emotes that were used/mentioned in this message.
282 283 284 285 286 287 |
# File 'lib/discordrb/data/message.rb', line 282 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.
291 292 293 |
# File 'lib/discordrb/data/message.rb', line 291 def emoji? emoji&.empty? end |
#from_bot? ⇒ true, false
Returns whether this message was sent by the current Bot.
272 273 274 |
# File 'lib/discordrb/data/message.rb', line 272 def from_bot? @author&.current_bot? end |
#inspect ⇒ Object
The inspect method is overwritten to give more useful output
386 387 388 |
# File 'lib/discordrb/data/message.rb', line 386 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.
391 392 393 |
# File 'lib/discordrb/data/message.rb', line 391 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.
303 304 305 |
# File 'lib/discordrb/data/message.rb', line 303 def my_reactions @reactions.select(&:me) end |
#pin(reason = nil) ⇒ Object
Pins this message
226 227 228 229 230 |
# File 'lib/discordrb/data/message.rb', line 226 def pin(reason = nil) API::Channel.(@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.
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/discordrb/data/message.rb', line 331 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.
297 298 299 |
# File 'lib/discordrb/data/message.rb', line 297 def reactions? !@reactions.empty? end |
#referenced_message ⇒ Message?
Returns the Message this Message was sent in reply to.
410 411 412 413 414 415 416 |
# File 'lib/discordrb/data/message.rb', line 410 def return @referenced_message if @referenced_message return nil unless @message_reference referenced_channel = @bot.channel(@message_reference['channel_id']) @referenced_message = referenced_channel.(@message_reference['message_id']) end |
#reply(content) ⇒ Message
Please use #respond.
Replies to this message with the specified content.
177 178 179 |
# File 'lib/discordrb/data/message.rb', line 177 def reply(content) @channel.(content) end |
#reply!(content, tts: false, embed: nil, attachments: nil, allowed_mentions: {}, mention_user: false, components: nil, flags: 0) ⇒ Message
Responds to this message as an inline reply.
191 192 193 194 195 196 197 |
# File 'lib/discordrb/data/message.rb', line 191 def reply!(content, tts: false, embed: nil, attachments: nil, allowed_mentions: {}, mention_user: false, components: nil, flags: 0) 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, , , allowed_mentions, self, components, flags) end |
#reply? ⇒ true, false
Whether or not this message was sent in reply to another message
399 400 401 |
# File 'lib/discordrb/data/message.rb', line 399 def reply? !@referenced_message.nil? end |
#respond(content, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil, components = nil, flags = 0) ⇒ Message
Sends a message to this channel.
200 201 202 |
# File 'lib/discordrb/data/message.rb', line 200 def respond(content, tts = false, = nil, = nil, allowed_mentions = nil, = nil, components = nil, flags = 0) @channel.(content, tts, , , allowed_mentions, , components, flags) end |
#suppress_embeds ⇒ Message
Removes embeds from the message
309 310 311 312 313 |
# File 'lib/discordrb/data/message.rb', line 309 def flags = @flags | (1 << 2) response = API::Channel.(@bot.token, @channel.id, @id, :undef, :undef, :undef, :undef, flags) Message.new(JSON.parse(response), @bot) end |
#to_message ⇒ Discordrb::Message Also known as: message
to_message -> self or message
434 435 436 |
# File 'lib/discordrb/data/message.rb', line 434 def self end |
#unpin(reason = nil) ⇒ Object
Unpins this message
233 234 235 236 237 |
# File 'lib/discordrb/data/message.rb', line 233 def unpin(reason = nil) API::Channel.(@bot.token, @channel.id, @id, reason) @pinned = false nil end |
#webhook? ⇒ true, false
Returns whether this message has been sent over a webhook.
277 278 279 |
# File 'lib/discordrb/data/message.rb', line 277 def webhook? !@webhook_id.nil? end |