Class: Discorb::Interaction

Inherits:
DiscordModel show all
Defined in:
lib/discorb/interaction/root.rb,
lib/discorb/interaction/response.rb

Overview

Represents a user interaction with the bot.

Defined Under Namespace

Modules: SourceResponse, UpdateResponse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DiscordModel

#==, #eql?, #hash

Instance Attribute Details

#application_id -> Discorb::Snowflake (readonly)

Returns The ID of the application that created the interaction.

Returns:



9
10
11
 
# File 'lib/discorb/interaction/root.rb', line 9

def application_id
  @application_id
end

#guild_locale -> Symbol (readonly)

Note:

This modifies the language code, - will be replaced with _.

Returns The locale of the guild that created the interaction.

Returns:

  • (Symbol) —

    The locale of the guild that created the interaction.



26
27
28
 
# File 'lib/discorb/interaction/root.rb', line 26

def guild_locale
  @guild_locale
end

#id -> Discorb::Snowflake (readonly)

Returns The ID of the interaction.

Returns:



7
8
9
 
# File 'lib/discorb/interaction/root.rb', line 7

def id
  @id
end

#locale -> Symbol (readonly)

Note:

This modifies the language code, - will be replaced with _.

Returns The locale of the user that created the interaction.

Returns:

  • (Symbol) —

    The locale of the user that created the interaction.



23
24
25
 
# File 'lib/discorb/interaction/root.rb', line 23

def locale
  @locale
end

#member -> Discorb::Member (readonly)

Returns The member that created the interaction.

Returns:



13
14
15
 
# File 'lib/discorb/interaction/root.rb', line 13

def member
  @member
end

#token -> String (readonly)

Returns The token for the interaction.

Returns:

  • (String) —

    The token for the interaction.



20
21
22
 
# File 'lib/discorb/interaction/root.rb', line 20

def token
  @token
end

#type -> Symbol (readonly)

Returns The type of interaction.

Returns:

  • (Symbol) —

    The type of interaction.



11
12
13
 
# File 'lib/discorb/interaction/root.rb', line 11

def type
  @type
end

#user -> Discorb::User (readonly)

Returns The user that created the interaction.

Returns:



15
16
17
 
# File 'lib/discorb/interaction/root.rb', line 15

def user
  @user
end

#version -> Integer (readonly)

Note:

This is always 1 for now.

Returns The type of interaction.

Returns:

  • (Integer) —

    The type of interaction.



18
19
20
 
# File 'lib/discorb/interaction/root.rb', line 18

def version
  @version
end

Instance Method Details

#channel -> Object 



64
65
66
 
# File 'lib/discorb/interaction/root.rb', line 64

def channel
  @client.channels[@channel_id]
end

#guild -> Object 



60
61
62
 
# File 'lib/discorb/interaction/root.rb', line 60

def guild
  @client.guilds[@guild_id]
end

#inspect -> Object 



75
76
77
 
# File 'lib/discorb/interaction/root.rb', line 75

def inspect
  "#<#{self.class} id=#{@id}>"
end

#target -> Object Also known as: fired_by, from 



68
69
70
 
# File 'lib/discorb/interaction/root.rb', line 68

def target
  @member || @user
end