Class: Rubycord::Interactions::Message

Inherits:

Object

Object
Rubycord::Interactions::Message

show all

Includes:: Rubycord::IDObject

Defined in:: lib/rubycord/data/interaction.rb

Overview

A message partial for interactions.

Instance Attribute Summary collapse

#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 collapse

#channel ⇒ Channel

The channel the interaction originates from.
#delete ⇒ Object

Delete this message.
#edit(content: nil, embeds: nil, allowed_mentions: nil, components: 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) {|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 ⇒ Rubycord::Message (also: #message)

Methods included from Rubycord::IDObject

#==, #creation_time, synthesise

Instance Attribute Details

#attachments ⇒ `Attachment` (readonly)

Returns:

(Attachment)



685
686
687

# File 'lib/rubycord/data/interaction.rb', line 685

def attachments
  @attachments
end

#author ⇒ `User` (readonly)

Returns The user of the application.

Returns:

(User) —

The user of the application.



682
683
684

# File 'lib/rubycord/data/interaction.rb', line 682

def author
  @author
end

#channel_id ⇒ `Integer` (readonly)

Returns:

(Integer)



697
698
699

# File 'lib/rubycord/data/interaction.rb', line 697

def channel_id
  @channel_id
end

#components ⇒ `Array<Component>` (readonly)

Returns:

(Array<Component>)



703
704
705

# File 'lib/rubycord/data/interaction.rb', line 703

def components
  @components
end

#content ⇒ `String`^? (readonly)

Returns The content of the message.

Returns:

(String, nil) —

The content of the message.



661
662
663

# File 'lib/rubycord/data/interaction.rb', line 661

def content
  @content
end

#edited ⇒ `true`, `false` (readonly)

Returns:

(true, false)



676
677
678

# File 'lib/rubycord/data/interaction.rb', line 676

def edited
  @edited
end

#edited_timestamp ⇒ `Time`^? (readonly)

Returns:

(Time, nil)



673
674
675

# File 'lib/rubycord/data/interaction.rb', line 673

def edited_timestamp
  @edited_timestamp
end

#embeds ⇒ `Array<Embed>` (readonly)

Returns:

(Array<Embed>)



688
689
690

# File 'lib/rubycord/data/interaction.rb', line 688

def embeds
  @embeds
end

#flags ⇒ `Integer` (readonly)

Returns:

(Integer)



694
695
696

# File 'lib/rubycord/data/interaction.rb', line 694

def flags
  @flags
end

#id ⇒ `Integer` (readonly)

Returns:

(Integer)



679
680
681

# File 'lib/rubycord/data/interaction.rb', line 679

def id
  @id
end

#interaction ⇒ `Interaction` (readonly)

Returns The interaction that created this message.

Returns:

(Interaction) —

The interaction that created this message.



658
659
660

# File 'lib/rubycord/data/interaction.rb', line 658

def interaction
  @interaction
end

#mentions ⇒ `Array<User>` (readonly)

Returns:

(Array<User>)



691
692
693

# File 'lib/rubycord/data/interaction.rb', line 691

def mentions
  @mentions
end

#message_reference ⇒ `Hash`^? (readonly)

Returns:

(Hash, nil)



700
701
702

# File 'lib/rubycord/data/interaction.rb', line 700

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.



664
665
666

# File 'lib/rubycord/data/interaction.rb', line 664

def pinned
  @pinned
end

#timestamp ⇒ `Time` (readonly)

Returns:

(Time)



670
671
672

# File 'lib/rubycord/data/interaction.rb', line 670

def timestamp
  @timestamp
end

#tts ⇒ `true`, `false` (readonly)

Returns:

(true, false)



667
668
669

# File 'lib/rubycord/data/interaction.rb', line 667

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:

(Errors::NoPermission) —

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



760
761
762

# File 'lib/rubycord/data/interaction.rb', line 760

def channel
  @bot.channel(@channel_id)
end

#delete ⇒ `Object`

Delete this message.



772
773
774

# File 'lib/rubycord/data/interaction.rb', line 772

def delete
  @interaction.delete_message(@id)
end

#edit(content: nil, embeds: nil, allowed_mentions: nil, components: 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.



781
782
783

# File 'lib/rubycord/data/interaction.rb', line 781

def edit(content: nil, embeds: nil, allowed_mentions: nil, components: nil, &)
  @interaction.edit_message(@id, content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components, &)
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.



748
749
750

# File 'lib/rubycord/data/interaction.rb', line 748

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

#respond(content: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: true, components: 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.

Yield Parameters:

builder (Webhooks::Builder) —

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



767
768
769

# File 'lib/rubycord/data/interaction.rb', line 767

def respond(content: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: true, components: nil, &)
  @interaction.send_message(content: content, embeds: embeds, allowed_mentions: allowed_mentions, flags: flags, ephemeral: ephemeral, components: components, &)
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.



754
755
756

# File 'lib/rubycord/data/interaction.rb', line 754

def server
  @bot.server(@server_id)
end

#to_message ⇒ `Rubycord::Message` Also known as: message

Returns:

(Rubycord::Message)



786
787
788

# File 'lib/rubycord/data/interaction.rb', line 786

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

Class: Rubycord::Interactions::Message

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Rubycord::IDObject

Instance Attribute Details

#attachments ⇒ Attachment (readonly)

#author ⇒ User (readonly)

#channel_id ⇒ Integer (readonly)

#components ⇒ Array<Component> (readonly)

#content ⇒ String? (readonly)

#edited ⇒ true, false (readonly)

#edited_timestamp ⇒ Time? (readonly)

#embeds ⇒ Array<Embed> (readonly)

#flags ⇒ Integer (readonly)

#id ⇒ Integer (readonly)

#interaction ⇒ Interaction (readonly)

#mentions ⇒ Array<User> (readonly)

#message_reference ⇒ Hash? (readonly)

#pinned ⇒ true, false (readonly)

#timestamp ⇒ Time (readonly)

#tts ⇒ true, false (readonly)

Instance Method Details

#channel ⇒ Channel

#delete ⇒ Object

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

#member ⇒ Member?

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

#server ⇒ Server?

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

#attachments ⇒ `Attachment` (readonly)

#author ⇒ `User` (readonly)

#channel_id ⇒ `Integer` (readonly)

#components ⇒ `Array<Component>` (readonly)

#content ⇒ `String`^? (readonly)

#edited ⇒ `true`, `false` (readonly)

#edited_timestamp ⇒ `Time`^? (readonly)

#embeds ⇒ `Array<Embed>` (readonly)

#flags ⇒ `Integer` (readonly)

#id ⇒ `Integer` (readonly)

#interaction ⇒ `Interaction` (readonly)

#mentions ⇒ `Array<User>` (readonly)

#message_reference ⇒ `Hash`^? (readonly)

#pinned ⇒ `true`, `false` (readonly)

#timestamp ⇒ `Time` (readonly)

#tts ⇒ `true`, `false` (readonly)

#channel ⇒ `Channel`

#delete ⇒ `Object`

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

#member ⇒ `Member`^?

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

#server ⇒ `Server`^?

#to_message ⇒ `Rubycord::Message` Also known as: message