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.



810
811
812
 
# File 'lib/discordrb/data/interaction.rb', line 810

def initialize
  @permissions = []
end

Instance Method Details

#allow(object) ⇒ PermissionBuilder

Allow an entity to use this command.

Parameters:

Returns:

Raises:

  • (ArgumentError) 


846
847
848
849
850
851
852
853
854
855
 
# File 'lib/discordrb/data/interaction.rb', line 846

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:



817
818
819
 
# File 'lib/discordrb/data/interaction.rb', line 817

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:



831
832
833
 
# File 'lib/discordrb/data/interaction.rb', line 831

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) 


861
862
863
864
865
866
867
868
869
870
 
# File 'lib/discordrb/data/interaction.rb', line 861

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:



824
825
826
 
# File 'lib/discordrb/data/interaction.rb', line 824

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:



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

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