Class: Discordrb::Profile

Inherits:
User
  • Object
show all
Defined in:
lib/discordrb/data.rb

Overview

This class is a special variant of User that represents the bot's user profile (things like own username and the avatar). It can be accessed using Bot#profile.

Instance Attribute Summary

Attributes inherited from User

#game, #status, #stream_type, #stream_url

Attributes included from UserAttributes

#avatar_id, #bot_account, #discriminator, #username

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods inherited from User

#await, #on, #pm, #send_file, #webhook?

Methods included from UserAttributes

#avatar_url, #distinct, #mention

Methods included from IDObject

#==, #creation_time, synthesise

Constructor Details

#initialize(data, bot) ⇒ Profile

Returns a new instance of Profile.


783
784
785
# File 'lib/discordrb/data.rb', line 783

def initialize(data, bot)
  super(data, bot)
end

Instance Method Details

#avatar=(avatar) ⇒ Object

Changes the bot's avatar.

Parameters:

  • avatar (String, #read)

    A JPG file to be used as the avatar, either something readable (e.g. File Object) or as a data URL.


804
805
806
807
808
809
810
811
812
813
814
815
# File 'lib/discordrb/data.rb', line 804

def avatar=(avatar)
  if avatar.respond_to? :read    # Set the file to binary mode if supported, so we don't get problems with Windows

    avatar.binmode if avatar.respond_to?(:binmode)

    avatar_string = 'data:image/jpg;base64,'
    avatar_string += Base64.strict_encode64(avatar.read)
    update_profile_data(avatar: avatar_string)
  else
    update_profile_data(avatar: avatar)
  end
end

#current_bot?true

Whether or not the user is the bot. The Profile can only ever be the bot user, so this always returns true.

Returns:

  • (true)

789
790
791
# File 'lib/discordrb/data.rb', line 789

def current_bot?
  true
end

#dndObject Also known as: busy

Note:

Only usable on User accounts.

Sets the user status setting to Do Not Disturb.


839
840
841
# File 'lib/discordrb/data.rb', line 839

def dnd
  update_profile_status_setting('dnd')
end

#idleObject

Note:

Only usable on User accounts.

Sets the user status setting to Idle.


833
834
835
# File 'lib/discordrb/data.rb', line 833

def idle
  update_profile_status_setting('idle')
end

#inspectObject

The inspect method is overwritten to give more useful output


852
853
854
# File 'lib/discordrb/data.rb', line 852

def inspect
  "<Profile user=#{super}>"
end

#invisibleObject

Note:

Only usable on User accounts.

Sets the user status setting to Invisible.


847
848
849
# File 'lib/discordrb/data.rb', line 847

def invisible
  update_profile_status_setting('invisible')
end

#onlineObject

Note:

Only usable on User accounts.

Sets the user status setting to Online.


827
828
829
# File 'lib/discordrb/data.rb', line 827

def online
  update_profile_status_setting('online')
end

#username=(username) ⇒ Object Also known as: name=

Sets the bot's username.

Parameters:

  • username (String)

    The new username.


795
796
797
# File 'lib/discordrb/data.rb', line 795

def username=(username)
  update_profile_data(username: username)
end