Class: Discordrb::Interactions::Message

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

Overview

A message partial for interactions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Discordrb::IDObject

#==, #creation_time, synthesise

Instance Attribute Details

#attachments ⇒ Attachment (readonly)

Returns:



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

def attachments
  @attachments
end

#author ⇒ User (readonly)

Returns The user of the application.

Returns:

  • (User) —

    The user of the application.



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

def author
  @author
end

#channel_id ⇒ Integer (readonly)

Returns:



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

def channel_id
  @channel_id
end

#components ⇒ Array<Component> (readonly)

Returns:

  • (Array<Component>) 


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

def components
  @components
end

#content ⇒ String? (readonly)

Returns The content of the message.

Returns:

  • (String, nil) —

    The content of the message.



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

def content
  @content
end

#edited ⇒ true, false (readonly)

Returns:

  • (true, false) 


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

def edited
  @edited
end

#edited_timestamp ⇒ Time? (readonly)

Returns:

  • (Time, nil) 


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

def edited_timestamp
  @edited_timestamp
end

#embeds ⇒ Array<Embed> (readonly)

Returns:



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

def embeds
  @embeds
end

#flags ⇒ Integer (readonly)

Returns:



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

def flags
  @flags
end

#id ⇒ Integer (readonly)

Returns:



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

def id
  @id
end

#interaction ⇒ Interaction (readonly)

Returns The interaction that created this message.

Returns:

  • (Interaction) —

    The interaction that created this message.



792
793
794
 
# File 'lib/discordrb/data/interaction.rb', line 792

def interaction
  @interaction
end

#mentions ⇒ Array<User> (readonly)

Returns:



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

def mentions
  @mentions
end

#message_reference ⇒ Hash? (readonly)

Returns:

  • (Hash, nil) 


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

def message_reference
  @message_reference
end

#pinned ⇒ true, false (readonly)

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

Returns:

  • (true, false) —

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



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

def pinned
  @pinned
end

#timestamp ⇒ Time (readonly)

Returns:

  • (Time) 


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

def timestamp
  @timestamp
end

#tts ⇒ true, false (readonly)

Returns:

  • (true, false) 


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

def tts
  @tts
end

Instance Method Details

#channel ⇒ Channel

Returns The channel the interaction originates from.

Returns:

  • (Channel) —

    The channel the interaction originates from.

Raises:



894
895
896
 
# File 'lib/discordrb/data/interaction.rb', line 894

def channel
  @bot.channel(@channel_id)
end

#delete ⇒ Object

Delete this message.



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

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.

Parameters:

  • content (String) (defaults to: nil) —

    The content of the message.

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

    The embeds for the message.

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

    Mentions that can ping on this message.

Yield Parameters:

  • builder (Webhooks::Builder) —

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



915
916
917
 
# File 'lib/discordrb/data/interaction.rb', line 915

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?

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

Returns:

  • (Member, nil) —

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



882
883
884
 
# File 'lib/discordrb/data/interaction.rb', line 882

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.

Parameters:

  • content (String) (defaults to: nil) —

    The content of the message.

  • tts (true, false)
  • embeds (Array<Hash, Webhooks::Embed>) (defaults to: nil) —

    The embeds for the message.

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

    Mentions that can ping on this message.

  • flags (Integer) (defaults to: 0) —

    Message flags.

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

    Whether this message should only be visible to the interaction initiator.

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

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

Yield Parameters:

  • builder (Webhooks::Builder) —

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



901
902
903
 
# File 'lib/discordrb/data/interaction.rb', line 901

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?

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

Returns:

  • (Server, nil) —

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



888
889
890
 
# File 'lib/discordrb/data/interaction.rb', line 888

def server
  @bot.server(@server_id)
end

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

Returns:



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

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