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:



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

def attachments
  @attachments
end

#author ⇒ User (readonly)

Returns The user of the application.

Returns:

  • (User) —

    The user of the application.



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

def author
  @author
end

#channel_id ⇒ Integer (readonly)

Returns:



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

def channel_id
  @channel_id
end

#components ⇒ Array<Component> (readonly)

Returns:

  • (Array<Component>) 


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

def components
  @components
end

#content ⇒ String? (readonly)

Returns The content of the message.

Returns:

  • (String, nil) —

    The content of the message.



865
866
867
 
# File 'lib/discordrb/data/interaction.rb', line 865

def content
  @content
end

#edited ⇒ true, false (readonly)

Returns:

  • (true, false) 


880
881
882
 
# File 'lib/discordrb/data/interaction.rb', line 880

def edited
  @edited
end

#edited_timestamp ⇒ Time? (readonly)

Returns:

  • (Time, nil) 


877
878
879
 
# File 'lib/discordrb/data/interaction.rb', line 877

def edited_timestamp
  @edited_timestamp
end

#embeds ⇒ Array<Embed> (readonly)

Returns:



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

def embeds
  @embeds
end

#flags ⇒ Integer (readonly)

Returns:



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

def flags
  @flags
end

#id ⇒ Integer (readonly)

Returns:



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

def id
  @id
end

#interaction ⇒ Interaction (readonly)

Returns The interaction that created this message.

Returns:

  • (Interaction) —

    The interaction that created this message.



862
863
864
 
# File 'lib/discordrb/data/interaction.rb', line 862

def interaction
  @interaction
end

#mentions ⇒ Array<User> (readonly)

Returns:



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

def mentions
  @mentions
end

#message_reference ⇒ Hash? (readonly)

Returns:

  • (Hash, nil) 


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

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.



868
869
870
 
# File 'lib/discordrb/data/interaction.rb', line 868

def pinned
  @pinned
end

#timestamp ⇒ Time (readonly)

Returns:

  • (Time) 


874
875
876
 
# File 'lib/discordrb/data/interaction.rb', line 874

def timestamp
  @timestamp
end

#tts ⇒ true, false (readonly)

Returns:

  • (true, false) 


871
872
873
 
# File 'lib/discordrb/data/interaction.rb', line 871

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:



964
965
966
 
# File 'lib/discordrb/data/interaction.rb', line 964

def channel
  @bot.channel(@channel_id)
end

#delete ⇒ Object

Delete this message.



976
977
978
 
# File 'lib/discordrb/data/interaction.rb', line 976

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.



985
986
987
 
# File 'lib/discordrb/data/interaction.rb', line 985

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.



952
953
954
 
# File 'lib/discordrb/data/interaction.rb', line 952

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 and components via attachment://file.png.

  • has_components (true, false) —

    Whether this message includes any V2 components. Enabling this disables content and embeds.

Yield Parameters:

  • builder (Webhooks::Builder) —

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



971
972
973
 
# File 'lib/discordrb/data/interaction.rb', line 971

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.



958
959
960
 
# File 'lib/discordrb/data/interaction.rb', line 958

def server
  @bot.server(@server_id)
end

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

Returns:



990
991
992
 
# File 'lib/discordrb/data/interaction.rb', line 990

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