Class: KHL::HTTP::Guild

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

Overview

服务器相关接口 developer.kaiheila.cn/doc/http/guild

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

#kickout(guild_id, target_id) ⇒ KHL::HTTP::Response

踢出服务器

Parameters:

  • guild_id (String) —

    服务器 ID

  • target_id (String) —

    用户 ID

Returns:



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

def kickout(guild_id, target_id)
  post(guild_id: guild_id, target_id: target_id)
end

#leave(guild_id) ⇒ KHL::HTTP::Response

离开服务器

Parameters:

  • guild_id (String) —

    服务器 ID

Returns:



57
58
59
 
# File 'lib/khl/http/guild.rb', line 57

def leave(guild_id)
  post(guild_id: guild_id)
end

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

获取当前用户加入的服务器列表

Parameters:

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

    可选参数

Options Hash (options):

  • :page (Integer) —

    页数

  • :page_size (Integer) —

    每页数据数量

  • :sort (String) —

    代表排序的字段，比如 -id 代表 id 按 DESC 排序，id 代表 id 按 ASC 排序

Returns:



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

def list(options = {})
  get(options)
end

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

修改服务器中用户的昵称

Parameters:

  • guild_id (String) —

    服务器 ID

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

    可选参数

Options Hash (options):

  • :nickname (String) —

    昵称，2-64 长度，不传则清空昵称

  • :user_id (String) —

    用户 ID，不传则修改当前登陆用户的昵称

Returns:



50
51
52
 
# File 'lib/khl/http/guild.rb', line 50

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

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

获取服务器中的用户列表

Parameters:

  • guild_id (String) —

    服务器 ID

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

    可选参数

Options Hash (options):

  • :channel_id (String) —

    频道 ID

  • :search (String) —

    搜索关键字，在用户名或昵称中搜索

  • :role_id (Integer) —

    角色 ID，获取特定角色的用户列表

  • :mobile_verified (Integer) —

    只能为 0 或 1，0 是未认证，1 是已认证

  • :active_time (Integer) —

    根据活跃时间排序，0 是顺序排列，1 是倒序排列

  • :joined_at (Integer) —

    根据加入时间排序，0 是顺序排列，1 是倒序排列

  • :page (Integer) —

    页数

  • :page_size (Integer) —

    每页数据数量

  • :filter_user_id (String) —

    获取指定 ID 所属用户的信息

Returns:



40
41
42
 
# File 'lib/khl/http/guild.rb', line 40

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

#view(guild_id) ⇒ KHL::HTTP::Response

获取服务器详情

Parameters:

  • guild_id (String) —

    服务器 ID

Returns:



23
24
25
 
# File 'lib/khl/http/guild.rb', line 23

def view(guild_id)
  get(guild_id: guild_id)
end