Class: Discordrb::Interactions::Message

Inherits:

Object

• Object
• Discordrb::Interactions::Message

Includes:

Discordrb::IDObject

Defined in:

lib/discordrb/data/interaction.rb

Overview

A message partial for interactions.

Instance Attribute Summary

• #attachments ⇒ Attachment readonly
• #author ⇒ User readonly

  The user of the application.

• #channel_id ⇒ Integer readonly
• #components ⇒ Array<Component> readonly
• #content ⇒ String^? readonly

  The content of the message.

• #edited ⇒ true, false readonly
• #edited_timestamp ⇒ Time^? readonly
• #embeds ⇒ Array<Embed> readonly
• #flags ⇒ Integer readonly
• #id ⇒ Integer readonly
• #interaction ⇒ Interaction readonly

  The interaction that created this message.

• #mentions ⇒ Array<User> readonly
• #message_reference ⇒ Hash^? readonly
• #pinned ⇒ true, false readonly

  Whether this message is pinned in the channel it belongs to.

• #timestamp ⇒ Time readonly
• #tts ⇒ true, false readonly

Instance Method Summary

• #channel ⇒ Channel

  The channel the interaction originates from.

• #delete ⇒ Object

  Delete this message.

• #edit(content: nil, embeds: nil, allowed_mentions: nil, components: nil, attachments: nil) {|builder| ... } ⇒ Object

  Edit this message's data.

• #member ⇒ Member^?

  This will return nil if the bot does not have access to the server the interaction originated in.

• #respond(content: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: true, components: nil, attachments: nil) {|builder| ... } ⇒ Object

  Respond to this message.

• #server ⇒ Server^?

  This will return nil if the bot does not have access to the server the interaction originated in.

• #to_message ⇒ Discordrb::Message (also: #message)

Methods included from Discordrb::IDObject

#==, #creation_time, synthesise

Instance Attribute Details

#attachments ⇒ Attachment (readonly)

# File 'lib/discordrb/data/interaction.rb', line 824

def attachments
  @attachments
end

#author ⇒ User (readonly)

# File 'lib/discordrb/data/interaction.rb', line 821

def author
  @author
end

#channel_id ⇒ Integer (readonly)

# File 'lib/discordrb/data/interaction.rb', line 836

def channel_id
  @channel_id
end

#components ⇒ Array<Component> (readonly)

# File 'lib/discordrb/data/interaction.rb', line 842

def components
  @components
end

#content ⇒ String^? (readonly)

# File 'lib/discordrb/data/interaction.rb', line 800

def content
  @content
end

#edited ⇒ true, false (readonly)

# File 'lib/discordrb/data/interaction.rb', line 815

def edited
  @edited
end

#edited_timestamp ⇒ Time^? (readonly)

# File 'lib/discordrb/data/interaction.rb', line 812

def edited_timestamp
  @edited_timestamp
end

#embeds ⇒ Array<Embed> (readonly)

# File 'lib/discordrb/data/interaction.rb', line 827

def embeds
  @embeds
end

#flags ⇒ Integer (readonly)

# File 'lib/discordrb/data/interaction.rb', line 833

def flags
  @flags
end

#id ⇒ Integer (readonly)

# File 'lib/discordrb/data/interaction.rb', line 818

def id
  @id
end

#interaction ⇒ Interaction (readonly)

# File 'lib/discordrb/data/interaction.rb', line 797

def interaction
  @interaction
end

#mentions ⇒ Array<User> (readonly)

# File 'lib/discordrb/data/interaction.rb', line 830

def mentions
  @mentions
end

#message_reference ⇒ Hash^? (readonly)

# File 'lib/discordrb/data/interaction.rb', line 839

def message_reference
  @message_reference
end

#pinned ⇒ true, false (readonly)

# File 'lib/discordrb/data/interaction.rb', line 803

def pinned
  @pinned
end

#timestamp ⇒ Time (readonly)

# File 'lib/discordrb/data/interaction.rb', line 809

def timestamp
  @timestamp
end

#tts ⇒ true, false (readonly)

# File 'lib/discordrb/data/interaction.rb', line 806

def tts
  @tts
end

Instance Method Details

#channel ⇒ Channel

Returns The channel the interaction originates from.

Raises:

• (Errors::NoPermission) —

  When the bot is not in the server associated with this interaction.

# File 'lib/discordrb/data/interaction.rb', line 899

def channel
  @bot.channel(@channel_id)
end

#delete ⇒ Object

Delete this message.

# File 'lib/discordrb/data/interaction.rb', line 911

def delete
  @interaction.delete_message(@id)
end

#edit(content: nil, embeds: nil, allowed_mentions: nil, components: nil, attachments: nil) {|builder| ... } ⇒ Object

Edit this message's data.

Yield Parameters:

• builder (Webhooks::Builder) —

  An optional message builder. Arguments passed to the method overwrite builder data.

# File 'lib/discordrb/data/interaction.rb', line 920

def edit(content: nil, embeds: nil, allowed_mentions: nil, components: nil, attachments: nil, &block)
  @interaction.edit_message(@id, content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components, attachments: attachments, &block)
end

#member ⇒ Member^?

# File 'lib/discordrb/data/interaction.rb', line 887

def member
  server&.member(@user.id)
end

#respond(content: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: true, components: nil, attachments: nil) {|builder| ... } ⇒ Object

Respond to this message.

Yield Parameters:

• builder (Webhooks::Builder) —

  An optional message builder. Arguments passed to the method overwrite builder data.

# File 'lib/discordrb/data/interaction.rb', line 906

def respond(content: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: true, components: nil, attachments: nil, &block)
  @interaction.send_message(content: content, embeds: embeds, allowed_mentions: allowed_mentions, flags: flags, ephemeral: ephemeral, components: components, attachments: attachments, &block)
end

#server ⇒ Server^?

# File 'lib/discordrb/data/interaction.rb', line 893

def server
  @bot.server(@server_id)
end

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

# File 'lib/discordrb/data/interaction.rb', line 925

def to_message
  Discordrb::Message.new(@data, @bot)
end