Class: KHL::HTTP::Blacklist

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

Overview

黑名单相关接口 developer.kaiheila.cn/doc/http/blacklist

Constant Summary

Constants inherited from Base

KHL::HTTP::Base::API_VERSION, KHL::HTTP::Base::BASE_URL, KHL::HTTP::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, target_id, options = {}) ⇒ KHL::HTTP::Response

加入黑名单

Parameters:

  • guild_id (String) —

    服务器 ID

  • target_id (String) —

    用户 ID

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

    可选参数

Options Hash (options):

  • :remark (String) —

    加入黑名单的原因

  • :del_msg_days (Integer) —

    删除最近几天的消息，最大 7 天，默认 0

Returns:



28
29
30
 
# File 'lib/khl/http/blacklist.rb', line 28

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

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

移除黑名单

Parameters:

  • guild_id (String) —

    服务器 ID

  • target_id (String) —

    用户 ID

Returns:



36
37
38
 
# File 'lib/khl/http/blacklist.rb', line 36

def delete(guild_id, target_id)
  post(guild_id: guild_id, target_id: target_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) —

    每页数据数量

  • :sort (String) —

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

Returns:



17
18
19
 
# File 'lib/khl/http/blacklist.rb', line 17

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