Class: Discordrb::Interactions::PermissionBuilder Deprecated

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

Overview

Deprecated.

This system is being replaced in the near future.

Builder for creating server application command permissions.

Constant Summary collapse

ROLE =

Role permission type

1
USER =

User permission type

2

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PermissionBuilder

Returns a new instance of PermissionBuilder.



579
580
581
 
# File 'lib/discordrb/data/interaction.rb', line 579

def initialize
  @permissions = []
end

Instance Method Details

#allow(object) ⇒ PermissionBuilder

Allow an entity to use this command.

Parameters:

Returns:

Raises:

  • (ArgumentError) 


615
616
617
618
619
620
621
622
623
624
 
# File 'lib/discordrb/data/interaction.rb', line 615

def allow(object)
  case object
  when Discordrb::User, Discordrb::Member
    create_entry(object.id, USER, true)
  when Discordrb::Role
    create_entry(object.id, ROLE, true)
  else
    raise ArgumentError, "Unable to create permission for unknown type: #{object.class}"
  end
end

#allow_role(role_id) ⇒ PermissionBuilder

Allow a role to use this command.

Parameters:

Returns:



586
587
588
 
# File 'lib/discordrb/data/interaction.rb', line 586

def allow_role(role_id)
  create_entry(role_id, ROLE, true)
end

#allow_user(user_id) ⇒ PermissionBuilder

Allow a user to use this command.

Parameters:

Returns:



600
601
602
 
# File 'lib/discordrb/data/interaction.rb', line 600

def allow_user(user_id)
  create_entry(user_id, USER, true)
end

#deny(object) ⇒ PermissionBuilder

Deny an entity usage of this command.

Parameters:

Returns:

Raises:

  • (ArgumentError) 


630
631
632
633
634
635
636
637
638
639
 
# File 'lib/discordrb/data/interaction.rb', line 630

def deny(object)
  case object
  when Discordrb::User, Discordrb::Member
    create_entry(object.id, USER, false)
  when Discordrb::Role
    create_entry(object.id, ROLE, false)
  else
    raise ArgumentError, "Unable to create permission for unknown type: #{object.class}"
  end
end

#deny_role(role_id) ⇒ PermissionBuilder

Deny a role usage of this command.

Parameters:

Returns:



593
594
595
 
# File 'lib/discordrb/data/interaction.rb', line 593

def deny_role(role_id)
  create_entry(role_id, ROLE, false)
end

#deny_user(user_id) ⇒ PermissionBuilder

Deny a user usage of this command.

Parameters:

Returns:



607
608
609
 
# File 'lib/discordrb/data/interaction.rb', line 607

def deny_user(user_id)
  create_entry(user_id, USER, false)
end