Class: Discordrb::ServerBan

Inherits:

Object

• Object
• Discordrb::ServerBan

Defined in:

lib/discordrb/data/server.rb

Overview

A ban entry on a server.

Instance Attribute Summary

• #reason ⇒ String^? readonly

  The reason the user was banned, if provided.

• #server ⇒ Server readonly

  The server this ban belongs to.

• #user ⇒ User readonly

  The user that was banned.

Instance Method Summary

• #remove(reason = nil) ⇒ Object (also: #unban, #lift)

  Removes this ban on the associated user in the server.

Instance Attribute Details

#reason ⇒ String^? (readonly)

Returns the reason the user was banned, if provided.

Returns:

• (String, nil) —

  the reason the user was banned, if provided

# File 'lib/discordrb/data/server.rb', line 1353

def reason
  @reason
end

#server ⇒ Server (readonly)

Returns the server this ban belongs to.

Returns:

• (Server) —

  the server this ban belongs to

# File 'lib/discordrb/data/server.rb', line 1359

def server
  @server
end

#user ⇒ User (readonly)

Returns the user that was banned.

Returns:

• (User) —

  the user that was banned

# File 'lib/discordrb/data/server.rb', line 1356

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

# File 'lib/discordrb/data/server.rb', line 1370

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