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

Instance Attribute Summary collapse

Attributes included from UserAttributes

#avatar_id, #bot_account, #discriminator, #username

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods included from UserAttributes

#avatar_url, #distinct, #mention

Methods included from IDObject

#==, #creation_time, synthesise

Instance Attribute Details

#activitiesActivitySet (readonly)

Returns the activities of the user.

Returns:


55
56
57
# File 'lib/discordrb/data/user.rb', line 55

def activities
  @activities
end

#statusSymbol (readonly)

Returns the current online status of the user (:online, :offline or :idle).

Returns:

  • (Symbol)

    the current online status of the user (:online, :offline or :idle)


52
53
54
# File 'lib/discordrb/data/user.rb', line 52

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:


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

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:


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

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

#current_bot?true, false

Is the user the bot?

Returns:

  • (true, false)

    whether this user is the bot


147
148
149
# File 'lib/discordrb/data/user.rb', line 147

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

#dnd?true, false

Returns whether this user is set to do not disturb.

Returns:

  • (true, false)

    whether this user is set to do not disturb.


164
165
166
167
168
# File 'lib/discordrb/data/user.rb', line 164

%i[offline idle online dnd].each do |e|
  define_method(e.to_s + '?') do
    @status.to_sym == e
  end
end

#gameString?

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.

Returns:

  • (String, nil)

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


172
173
174
# File 'lib/discordrb/data/user.rb', line 172

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

#idle?true, false

Returns whether this user is idle.

Returns:

  • (true, false)

    whether this user is idle.


164
165
166
167
168
# File 'lib/discordrb/data/user.rb', line 164

%i[offline idle online dnd].each do |e|
  define_method(e.to_s + '?') do
    @status.to_sym == e
  end
end

#inspectObject

The inspect method is overwritten to give more useful output


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

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

#offline?true, false

Returns whether this user is offline.

Returns:

  • (true, false)

    whether this user is offline.


164
165
166
167
168
# File 'lib/discordrb/data/user.rb', line 164

%i[offline idle online dnd].each do |e|
  define_method(e.to_s + '?') do
    @status.to_sym == e
  end
end

#on(server) ⇒ Member

Gets the member this user is on a server

Parameters:

  • server (Server)

    The server to get the member for

Returns:

  • (Member)

    this user as a member on a particular server


140
141
142
143
# File 'lib/discordrb/data/user.rb', line 140

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

#online?true, false

Returns whether this user is online.

Returns:

  • (true, false)

    whether this user is online.


164
165
166
167
168
# File 'lib/discordrb/data/user.rb', line 164

%i[offline idle online dnd].each do |e|
  define_method(e.to_s + '?') do
    @status.to_sym == e
  end
end

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

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

Overloads:

  • #pmChannel

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

    Returns:

    • (Channel)

      the PM channel to this user.

  • #pm(content) ⇒ Message

    Sends a private to this user.

    Parameters:

    • content (String)

      The content to send.

    Returns:

    • (Message)

      the message sent to this user.


82
83
84
85
86
87
88
89
90
91
# File 'lib/discordrb/data/user.rb', line 82

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'))

Parameters:

  • file (File)

    The file to send to the user

  • caption (String) (defaults to: nil)

    The caption of the file being sent

  • filename (String) (defaults to: nil)

    Overrides the filename of the uploaded file

  • spoiler (true, false) (defaults to: nil)

    Whether or not this file should appear as a spoiler.

Returns:

  • (Message)

    the message sent to this user.


103
104
105
# File 'lib/discordrb/data/user.rb', line 103

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

#stream_typeInteger

Deprecated.

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

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

Returns:

  • (Integer)

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


178
179
180
# File 'lib/discordrb/data/user.rb', line 178

def stream_type
  @activities.streaming ? 1 : 0
end

#stream_urlString?

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.

Returns:

  • (String, nil)

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


184
185
186
# File 'lib/discordrb/data/user.rb', line 184

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

#webhook?true, false

Returns whether this user is a fake user for a webhook message.

Returns:

  • (true, false)

    whether this user is a fake user for a webhook message


152
153
154
# File 'lib/discordrb/data/user.rb', line 152

def webhook?
  @discriminator == Message::ZERO_DISCRIM
end