Module: Discordrb::UserAttributes

Included in:
Light::LightProfile, User
Defined in:
lib/discordrb/data.rb

Overview

Mixin for the attributes users should have

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#avatar_idString

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

Returns:

  • (String)

    the ID of this user's current avatar, can be used to generate an avatar URL.

See Also:


123
124
125
# File 'lib/discordrb/data.rb', line 123

def avatar_id
  @avatar_id
end

#bot_accounttrue, false (readonly) Also known as: bot_account?

Returns whether this user is a Discord bot account.

Returns:

  • (true, false)

    whether this user is a Discord bot account


118
119
120
# File 'lib/discordrb/data.rb', line 118

def 
  @bot_account
end

#discriminatorString (readonly) Also known as: discrim, tag, discord_tag

Returns this user's discriminator which is used internally to identify users with identical usernames.

Returns:

  • (String)

    this user's discriminator which is used internally to identify users with identical usernames.


112
113
114
# File 'lib/discordrb/data.rb', line 112

def discriminator
  @discriminator
end

#usernameString (readonly) Also known as: name

Returns this user's username.

Returns:

  • (String)

    this user's username


108
109
110
# File 'lib/discordrb/data.rb', line 108

def username
  @username
end

Instance Method Details

#avatar_url(format = nil) ⇒ String

Utility function to get a user's avatar URL.

Parameters:

  • format (String, nil) (defaults to: nil)

    If nil, the URL will default to webp for static avatars, and will detect if the user has a gif avatar. You can otherwise specify one of webp, jpg, png, or gif to override this. Will always be PNG for default avatars.

Returns:

  • (String)

    the URL to the avatar image.


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

def avatar_url(format = nil)
  return API::User.default_avatar(@discriminator) unless @avatar_id
  API::User.avatar_url(@id, @avatar_id, format)
end

#distinctString

Utility function to get Discord's distinct representation of a user, i.e. username + discriminator

Returns:

  • (String)

    distinct representation of user


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

def distinct
  "#{@username}##{@discriminator}"
end

#mentionString

Utility function to mention users in messages

Returns:

  • (String)

    the mention code in the form of <@id>


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

def mention
  "<@#{@id}>"
end