Class: Discordrb::Member

Inherits:
User
  • Object
show all
Includes:
MemberAttributes, PermissionCalculator
Defined in:
lib/discordrb/data.rb

Overview

A member is a user on a server. It differs from regular users in that it has roles, voice statuses and things like that.

Instance Attribute Summary

Attributes included from MemberAttributes

#joined_at, #nick, #roles, #server

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 included from PermissionCalculator

#defined_permission?, #permission?

Methods inherited from User

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

Methods included from UserAttributes

#avatar_url, #distinct, #mention

Methods included from IDObject

#==, #creation_time, synthesise

Instance Method Details

#add_role(role, reason = nil) ⇒ Object

Adds one or more roles to this member.

Parameters:


605
606
607
608
609
610
611
612
613
614
615
# File 'lib/discordrb/data.rb', line 605

def add_role(role, reason = nil)
  role_ids = role_id_array(role)

  if role_ids.count == 1
    API::Server.add_member_role(@bot.token, @server.id, @user.id, role_ids[0], reason)
  else
    old_role_ids = @roles.map(&:id)
    new_role_ids = (old_role_ids + role_ids).uniq
    API::Server.update_member(@bot.token, @server.id, @user.id, roles: new_role_ids, reason: reason)
  end
end

#colourColourRGB? Also known as: color

Returns the colour this member has.

Returns:

  • (ColourRGB, nil)

    the colour this member has.


653
654
655
656
# File 'lib/discordrb/data.rb', line 653

def colour
  return nil unless colour_role
  colour_role.color
end

#colour_roleRole? Also known as: color_role

Returns the role this member is basing their colour on.

Returns:

  • (Role, nil)

    the role this member is basing their colour on.


645
646
647
648
649
# File 'lib/discordrb/data.rb', line 645

def colour_role
  coloured_roles = @roles.select { |v| v.colour.combined.nonzero? }
  return nil if coloured_roles.empty?
  coloured_roles.sort_by(&:position).last
end

#deaftrue, false Also known as: deafened?

Returns whether this member is deafened server-wide.

Returns:

  • (true, false)

    whether this member is deafened server-wide.


516
517
518
# File 'lib/discordrb/data.rb', line 516

def deaf
  voice_state_attribute(:deaf)
end

#display_nameString

Returns the name the user displays as (nickname if they have one, username otherwise).

Returns:

  • (String)

    the name the user displays as (nickname if they have one, username otherwise)


704
705
706
# File 'lib/discordrb/data.rb', line 704

def display_name
  nickname || username
end

#highest_roleRole

Returns the highest role this member has.

Returns:

  • (Role)

    the highest role this member has.


633
634
635
# File 'lib/discordrb/data.rb', line 633

def highest_role
  @roles.sort_by(&:position).last
end

#hoist_roleRole?

Returns the role this member is being hoisted with.

Returns:

  • (Role, nil)

    the role this member is being hoisted with.


638
639
640
641
642
# File 'lib/discordrb/data.rb', line 638

def hoist_role
  hoisted_roles = @roles.select(&:hoist)
  return nil if hoisted_roles.empty?
  hoisted_roles.sort_by(&:position).last
end

#inspectObject

Overwriting inspect for debug purposes


727
728
729
# File 'lib/discordrb/data.rb', line 727

def inspect
  "<Member user=#{@user.inspect} server=#{@server.inspect} joined_at=#{@joined_at} roles=#{@roles.inspect} voice_channel=#{@voice_channel.inspect} mute=#{@mute} deaf=#{@deaf} self_mute=#{@self_mute} self_deaf=#{@self_deaf}>"
end

#modify_roles(add, remove, reason = nil) ⇒ Object

Adds and removes roles from a member.

Examples:

Remove the 'Member' role from a user, and add the 'Muted' role to them.

to_add = server.roles.find {|role| role.name == 'Muted'}
to_remove = server.roles.find {|role| role.name == 'Member'}
member.modify_roles(to_add, to_remove)

Parameters:

  • add (Role, Array<Role>)

    The role(s) to add.

  • remove (Role, Array<Role>)

    The role(s) to remove.

  • reason (String) (defaults to: nil)

    The reason the user's roles are being changed.


593
594
595
596
597
598
599
600
# File 'lib/discordrb/data.rb', line 593

def modify_roles(add, remove, reason = nil)
  add_role_ids = role_id_array(add)
  remove_role_ids = role_id_array(remove)
  old_role_ids = @roles.map(&:id)
  new_role_ids = (old_role_ids - remove_role_ids + add_role_ids).uniq

  API::Server.update_member(@bot.token, @server.id, @user.id, roles: new_role_ids, reason: reason)
end

#mutetrue, false Also known as: muted?

Returns whether this member is muted server-wide.

Returns:

  • (true, false)

    whether this member is muted server-wide.


511
512
513
# File 'lib/discordrb/data.rb', line 511

def mute
  voice_state_attribute(:mute)
end

#nick=(nick) ⇒ Object Also known as: nickname=

See Also:


680
681
682
# File 'lib/discordrb/data.rb', line 680

def nick=(nick)
  set_nick(nick)
end

#owner?true, false

Returns whether this member is the server owner.

Returns:

  • (true, false)

    whether this member is the server owner.


561
562
563
# File 'lib/discordrb/data.rb', line 561

def owner?
  @server.owner == self
end

#remove_role(role, reason = nil) ⇒ Object

Removes one or more roles from this member.

Parameters:

  • role (Role, Array<Role>)

    The role(s) to remove.

  • reason (String) (defaults to: nil)

    The reason the user's roles are being changed.


620
621
622
623
624
625
626
627
628
629
630
# File 'lib/discordrb/data.rb', line 620

def remove_role(role, reason = nil)
  role_ids = role_id_array(role)

  if role_ids.count == 1
    API::Server.remove_member_role(@bot.token, @server.id, @user.id, role_ids[0], reason)
  else
    old_role_ids = @roles.map(&:id)
    new_role_ids = old_role_ids.reject { |i| role_ids.include?(i) }
    API::Server.update_member(@bot.token, @server.id, @user.id, roles: new_role_ids, reason: reason)
  end
end

#role?(role) ⇒ true, false

Returns whether this member has the specified role.

Parameters:

Returns:

  • (true, false)

    whether this member has the specified role.


567
568
569
570
# File 'lib/discordrb/data.rb', line 567

def role?(role)
  role = role.resolve_id
  @roles.any? { |e| e.id == role }
end

#roles=(role) ⇒ Object

See Also:


573
574
575
# File 'lib/discordrb/data.rb', line 573

def roles=(role)
  set_roles(role)
end

#self_deaftrue, false Also known as: self_deafened?

Returns whether this member has deafened themselves.

Returns:

  • (true, false)

    whether this member has deafened themselves.


526
527
528
# File 'lib/discordrb/data.rb', line 526

def self_deaf
  voice_state_attribute(:self_deaf)
end

#self_mutetrue, false Also known as: self_muted?

Returns whether this member has muted themselves.

Returns:

  • (true, false)

    whether this member has muted themselves.


521
522
523
# File 'lib/discordrb/data.rb', line 521

def self_mute
  voice_state_attribute(:self_mute)
end

#server_deafenObject

Server deafens this member.


660
661
662
# File 'lib/discordrb/data.rb', line 660

def server_deafen
  API::Server.update_member(@bot.token, @server.id, @user.id, deaf: true)
end

#server_muteObject

Server mutes this member.


670
671
672
# File 'lib/discordrb/data.rb', line 670

def server_mute
  API::Server.update_member(@bot.token, @server.id, @user.id, mute: true)
end

#server_undeafenObject

Server undeafens this member.


665
666
667
# File 'lib/discordrb/data.rb', line 665

def server_undeafen
  API::Server.update_member(@bot.token, @server.id, @user.id, deaf: false)
end

#server_unmuteObject

Server unmutes this member.


675
676
677
# File 'lib/discordrb/data.rb', line 675

def server_unmute
  API::Server.update_member(@bot.token, @server.id, @user.id, mute: false)
end

#set_nick(nick, reason = nil) ⇒ Object Also known as: set_nickname

Sets or resets this member's nickname. Requires the Change Nickname permission for the bot itself and Manage Nicknames for other users.

Parameters:

  • nick (String, nil)

    The string to set the nickname to, or nil if it should be reset.

  • reason (String) (defaults to: nil)

    The reason the user's nickname is being changed.


690
691
692
693
694
695
696
697
698
699
# File 'lib/discordrb/data.rb', line 690

def set_nick(nick, reason = nil)
  # Discord uses the empty string to signify 'no nickname' so we convert nil into that
  nick ||= ''

  if @user.current_bot?
    API::User.change_own_nickname(@bot.token, @server.id, nick, reason)
  else
    API::Server.update_member(@bot.token, @server.id, @user.id, nick: nick, reason: nil)
  end
end

#set_roles(role, reason = nil) ⇒ Object

Bulk sets a member's roles.

Parameters:

  • role (Role, Array<Role>)

    The role(s) to set.

  • reason (String) (defaults to: nil)

    The reason the user's roles are being changed.


580
581
582
583
# File 'lib/discordrb/data.rb', line 580

def set_roles(role, reason = nil)
  role_ids = role_id_array(role)
  API::Server.update_member(@bot.token, @server.id, @user.id, roles: role_ids, reason: reason)
end

#voice_channelChannel

Returns the voice channel this member is in.

Returns:

  • (Channel)

    the voice channel this member is in.


531
532
533
# File 'lib/discordrb/data.rb', line 531

def voice_channel
  voice_state_attribute(:voice_channel)
end