Class: Discordrb::ServerBan

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

Overview

A ban entry on a server

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#reasonString? (readonly)

Returns the reason the user was banned, if provided.

Returns:

  • (String, nil)

    the reason the user was banned, if provided


978
979
980
# File 'lib/discordrb/data/server.rb', line 978

def reason
  @reason
end

#serverServer (readonly)

Returns the server this ban belongs to.

Returns:

  • (Server)

    the server this ban belongs to


984
985
986
# File 'lib/discordrb/data/server.rb', line 984

def server
  @server
end

#userUser (readonly)

Returns the user that was banned.

Returns:

  • (User)

    the user that was banned


981
982
983
# File 'lib/discordrb/data/server.rb', line 981

def user
  @user
end

Instance Method Details

#remove(reason = nil) ⇒ Object Also known as: unban, lift

Removes this ban on the associated user in the server

Parameters:

  • reason (String) (defaults to: nil)

    the reason for removing the ban


995
996
997
# File 'lib/discordrb/data/server.rb', line 995

def remove(reason = nil)
  @server.unban(user, reason)
end