Class: KHL::HTTP::GuildRole

Inherits:
Base
  • Object
show all
Defined in:
lib/khl/http/guild_role.rb

Overview

服务器角色权限相关接口 developer.kaiheila.cn/doc/http/guild-role

Constant Summary

Constants inherited from Base

Base::API_VERSION, Base::BASE_URL, Base::END_POINT

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

#get, #initialize, #post, #post_file

Constructor Details

This class inherits a constructor from KHL::HTTP::Base

Instance Method Details

#create(guild_id, options = {}) ⇒ KHL::HTTP::Response

创建服务器角色

Parameters:

  • guild_id (String) —

    服务器 ID

  • options (Hash) (defaults to: {}) —

    可选参数

Options Hash (options):

  • :name (String) —

    角色名称，如果不写，则为 “新角色”

Returns:



25
26
27
 
# File 'lib/khl/http/guild_role.rb', line 25

def create(guild_id, options = {})
  post(options.merge(guild_id: guild_id))
end

#delete(guild_id, role_id) ⇒ KHL::HTTP::Response

删除服务器角色

Parameters:

  • guild_id (String) —

    服务器 ID

  • role_id (Integer) —

    角色 ID

Returns:



47
48
49
 
# File 'lib/khl/http/guild_role.rb', line 47

def delete(guild_id, role_id)
  post(guild_id: guild_id, role_id: role_id)
end

#grant(guild_id, user_id, role_id) ⇒ KHL::HTTP::Response

赋予用户角色

Parameters:

  • guild_id (String) —

    服务器 ID

  • user_id (String) —

    用户 ID

  • role_id (Integer) —

    角色 ID

Returns:



56
57
58
 
# File 'lib/khl/http/guild_role.rb', line 56

def grant(guild_id, user_id, role_id)
  post(guild_id: guild_id, user_id: user_id, role_id: role_id)
end

#list(guild_id, options = {}) ⇒ KHL::HTTP::Response

获取服务器角色列表

Parameters:

  • guild_id (String) —

    服务器 ID

  • options (Hash) (defaults to: {}) —

    可选参数

Options Hash (options):

  • :page (Integer) —

    页数

  • :page_size (Integer) —

    每页数据数量

Returns:



16
17
18
 
# File 'lib/khl/http/guild_role.rb', line 16

def list(guild_id, options = {})
  get(options.merge(guild_id: guild_id))
end

#revoke(guild_id, user_id, role_id) ⇒ KHL::HTTP::Response

删除用户角色

Parameters:

  • guild_id (String) —

    服务器 ID

  • user_id (String) —

    用户 ID

  • role_id (Integer) —

    角色 ID

Returns:



65
66
67
 
# File 'lib/khl/http/guild_role.rb', line 65

def revoke(guild_id, user_id, role_id)
  post(guild_id: guild_id, user_id: user_id, role_id: role_id)
end

#update(guild_id, role_id, options = {}) ⇒ KHL::HTTP::Response

更新服务器角色

Parameters:

  • guild_id (String) —

    服务器 ID

  • role_id (Integer) —

    角色 ID

  • options (Hash) (defaults to: {}) —

    可选参数

Options Hash (options):

  • :name (String) —

    角色名称

  • :color (Integer) —

    颜色

  • :hoist (Integer) —

    只能为 0 或者 1，是否把该角色的用户在用户列表排到前面

  • :mentionable (Integer) —

    只能为 0 或者 1，该角色是否可以被提及

  • :permissions (Integer) —

    权限

Returns:



39
40
41
 
# File 'lib/khl/http/guild_role.rb', line 39

def update(guild_id, role_id, options = {})
  post(options.merge(guild_id: guild_id, role_id: role_id))
end