Class: Discordrb::User

Inherits:
Object
  • Object
show all
Includes:
IDObject, UserAttributes
Defined in:
lib/discordrb/data/user.rb

Overview

User on Discord, including internal data like discriminators

Direct Known Subclasses

Member, Profile, Recipient

Constant Summary

Constants included from UserAttributes

Discordrb::UserAttributes::FLAGS

Instance Attribute Summary collapse

Attributes included from UserAttributes

#avatar_decoration, #avatar_id, #bot_account, #collectibles, #discriminator, #global_name, #primary_server, #public_flags, #system_account, #username, #webhook_account

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods included from UserAttributes

#avatar_url, #banner_url, #display_name, #distinct, #mention

Methods included from IDObject

#==, #creation_time, synthesise

Instance Attribute Details

#activities ⇒ ActivitySet (readonly) 



130
131
132
 
# File 'lib/discordrb/data/user.rb', line 130

def activities
  @activities
end

#client_status ⇒ Hash<Symbol, Symbol> (readonly) 



134
135
136
 
# File 'lib/discordrb/data/user.rb', line 134

def client_status
  @client_status
end

#status ⇒ Symbol (readonly) 



127
128
129
 
# File 'lib/discordrb/data/user.rb', line 127

def status
  @status
end

Instance Method Details

#await(key, attributes = {}, &block) ⇒ Object

Add an await for a message from this user. Specifically, this adds a global await for a MessageEvent with this user's ID as a :from attribute.

See Also:



247
248
249
 
# File 'lib/discordrb/data/user.rb', line 247

def await(key, attributes = {}, &block)
  @bot.add_await(key, Discordrb::Events::MessageEvent, { from: @id }.merge(attributes), &block)
end

#await!(attributes = {}, &block) ⇒ Object

Add a blocking await for a message from this user. Specifically, this adds a global await for a MessageEvent with this user's ID as a :from attribute.

See Also:



254
255
256
 
# File 'lib/discordrb/data/user.rb', line 254

def await!(attributes = {}, &block)
  @bot.add_await!(Discordrb::Events::MessageEvent, { from: @id }.merge(attributes), &block)
end

Returns the ID of this user's current banner, can be used to generate a banner URL.

See Also:



195
196
197
 
# File 'lib/discordrb/data/user.rb', line 195

def banner_id
  @banner_id ||= JSON.parse(API::User.resolve(@bot.token, @id))['banner']
end

#current_bot? ⇒ true, false

Is the user the bot?



268
269
270
 
# File 'lib/discordrb/data/user.rb', line 268

def current_bot?
  @bot.profile.id == @id
end

#dnd? ⇒ true, false 



295
296
297
298
299
 
# File 'lib/discordrb/data/user.rb', line 295

i[offline idle online dnd].each do |e|
  define_method("#{e}?") do
    @status.to_sym == e
  end
end

#game ⇒ String?

Deprecated.

Please use ActivitySet#games for information about the user's game activity

Returns the game the user is currently playing, or nil if nothing is being played.



303
304
305
 
# File 'lib/discordrb/data/user.rb', line 303

def game
  @activities.games.first&.name
end

#idle? ⇒ true, false 



295
296
297
298
299
 
# File 'lib/discordrb/data/user.rb', line 295

i[offline idle online dnd].each do |e|
  define_method("#{e}?") do
    @status.to_sym == e
  end
end

#inspect ⇒ Object

The inspect method is overwritten to give more useful output



320
321
322
 
# File 'lib/discordrb/data/user.rb', line 320

def inspect
  "<User username=#{@username} id=#{@id} discriminator=#{@discriminator}>"
end

#offline? ⇒ true, false 



295
296
297
298
299
 
# File 'lib/discordrb/data/user.rb', line 295

i[offline idle online dnd].each do |e|
  define_method("#{e}?") do
    @status.to_sym == e
  end
end

#on(server) ⇒ Member

Gets the member this user is on a server



261
262
263
264
 
# File 'lib/discordrb/data/user.rb', line 261

def on(server)
  id = server.resolve_id
  @bot.server(id).member(@id)
end

#online? ⇒ true, false 



295
296
297
298
299
 
# File 'lib/discordrb/data/user.rb', line 295

i[offline idle online dnd].each do |e|
  define_method("#{e}?") do
    @status.to_sym == e
  end
end

#pm ⇒ Channel #pm(content) ⇒ Message Also known as: dm

Get a user's PM channel or send them a PM

Overloads:

  • #pm ⇒ Channel

    Creates a private message channel for this user or returns an existing one if it already exists

  • #pm(content) ⇒ Message

    Sends a private to this user.



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/discordrb/data/user.rb', line 168

def pm(content = nil)
  if content
    # Recursively call pm to get the channel, then send a message to it
    channel = pm
    channel.send_message(content)
  else
    # If no message was specified, return the PM channel
    @bot.pm_channel(@id)
  end
end

#send_file(file, caption = nil, filename: nil, spoiler: nil) ⇒ Message

Send the user a file.

Examples:

Send a file from disk

user.send_file(File.open('rubytaco.png', 'r'))



189
190
191
 
# File 'lib/discordrb/data/user.rb', line 189

def send_file(file, caption = nil, filename: nil, spoiler: nil)
  pm.send_file(file, caption: caption, filename: filename, spoiler: spoiler)
end

#stream_type ⇒ Integer

Deprecated.

Please use ActivitySet#streaming for information about the user's stream activity

Returns 1 for twitch streams, or 0 for no stream.



309
310
311
 
# File 'lib/discordrb/data/user.rb', line 309

def stream_type
  @activities.streaming ? 1 : 0
end

#stream_url ⇒ String?

Deprecated.

Please use ActivitySet#streaming for information about the user's stream activity

Returns the URL to the stream, if the user is currently streaming something.



315
316
317
 
# File 'lib/discordrb/data/user.rb', line 315

def stream_url
  @activities.streaming.first&.url
end