leiting.sword
简介
组件接口
类
LtSwordNicknameRequest
继承自 LtRequest
敏感词检测请求-昵称检测
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| game | string | nil | 可选 | 游戏标识 - Y |
| userId | string | nil | 可选 | 手游账号 长度不能超过50 - Y |
| channelNo | string | nil | 可选 | 渠道ID。例如110003：九游；130009：4399 |
| os | int | nil | 可选 | 系统 1:android 2 ios 3 web 4 pc端 - Y |
| roleId | string | nil | 可选 | 玩家角色ID - Y |
| roleName | string | nil | 可选 | 角色昵称 - Y |
| roleLevel | string | nil | 可选 | 游戏等级 - Y |
| serverId | string | nil | 可选 | 游戏区组 - Y |
| content | string | nil | 可选 | 文本内容 长度小于2000 - Y 用户发表内容，建议对内容中JSON、表情符,回车，换行、HTML标签、 UBB标签等做过滤，只传递纯文本，以减少误判概率 |
| ip | string | nil | 可选 | 玩家客户端IP地址 - Y |
| isYd | int | nil | 可选 | 未说明字段,默认 填2 - Y |
| isReplace | int | nil | 可选 | 是否将拦截敏感词替换 - Y 1替换 0不替换 默认0，该值需传1。 特别提醒：会存在三方服务未返回敏感词，从而导致敏感文本无法被替换为*的情况。 |
| userName | string | nil | 可选 | 雷霆用户名 - N |
| channel | string | nil | 可选 | 发言频道（世界、帮会） |
| imei | string | nil | 可选 | 客户端手机imei |
| mac | string | nil | 可选 | mac地址 - N |
| recvRoleId | string | nil | 可选 | 发言接收方roleId 聊天场景 - N |
| isReturnWord | int | nil | 可选 | 是否将匹配到的敏感词返回 - N 0 不返回 1返回 默认为0不返回 |
| ydSecretId | string | nil | 可选 | 自定义易盾业务ID，没有特别要求不需要填，具体可联系黑产组 - N |
成员方法
| 函数原型 | 函数作用 |
|---|---|
| string get_url(string host) | 获取接口地址 |
| bool check_integrity() | |
| string gen_sign_text(string key) | 生成待签名文本 |
| LtResult new_result() | 生成结果实例 |
LtSwordTextRequest
继承自 LtRequest
敏感词检测请求-全文本检测
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| game | string | nil | 可选 | 游戏标识 - Y |
| userId | string | nil | 可选 | 手游账号 长度不能超过50 - Y |
| channelNo | string | nil | 可选 | 渠道ID。例如110003：九游；130009：4399 |
| os | int | nil | 可选 | 系统 1:android 2 ios 3 web 4 pc端 - Y |
| roleId | string | nil | 可选 | 玩家角色ID - Y |
| roleName | string | nil | 可选 | 角色昵称 - Y |
| roleLevel | string | nil | 可选 | 游戏等级 - Y |
| serverId | string | nil | 可选 | 游戏区组 - Y |
| content | string | nil | 可选 | 文本内容 长度小于2000 - Y 用户发表内容，建议对内容中JSON、表情符,回车，换行、HTML标签、 UBB标签等做过滤，只传递纯文本，以减少误判概率 |
| ip | string | nil | 可选 | 玩家客户端IP地址 - Y |
| isYd | int | nil | 可选 | 未说明字段,默认 填2 - Y |
| isReplace | int | nil | 可选 | 是否将拦截敏感词替换 - Y 1替换 0不替换 默认0，该值需传1。 特别提醒：会存在三方服务未返回敏感词，从而导致敏感文本无法被替换为*的情况。 |
| userName | string | nil | 可选 | 雷霆用户名 - N |
| channel | string | nil | 可选 | 发言频道（世界、帮会） |
| imei | string | nil | 可选 | 客户端手机imei |
| mac | string | nil | 可选 | mac地址 - N |
| recvRoleId | string | nil | 可选 | 发言接收方roleId 聊天场景 - N |
| isReturnWord | int | nil | 可选 | 是否将匹配到的敏感词返回 - N 0 不返回 1返回 默认为0不返回 |
| ydSecretId | string | nil | 可选 | 自定义易盾业务ID，没有特别要求不需要填，具体可联系黑产组 - N |
| ydBusinessId | string | nil | 可选 | 填该参数时，ydSecretId 不能为空 - N |
成员方法
| 函数原型 | 函数作用 |
|---|---|
| string get_url(string host) | 获取接口地址 |
| bool check_integrity() | |
| string gen_sign_text(string key) | 生成待签名文本 |
| LtResult new_result() | 生成请求结果的实例 |
LtSwordBatchRequest
继承自 LtRequest
敏感词检测请求-批量检测
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| game | string | nil | 可选 | 游戏标识 - Y |
| type | int | nil | 可选 | 检测类型。1昵称；2全文本 - Y |
| contents | map | nil | 可选 | 内容。一次批量条数不得大于100条，每条一个key用于区分检查结果 - Y |
| isYd | int | nil | 可选 | 是否过易盾 1只平台处理 2 平台处理后过易盾 - Y |
| ydSecretId | string | nil | 可选 | 易盾独立产品ID,（问道，一念逍遥，奥比岛必填） - Y |
| channelNo | string | nil | 可选 | 渠道ID。例如110003：九游；130009：4399 - N |
| isReturnWord | int | 0 | 可选 | 是否将匹配到的敏感词返回 ：0 不返回 1返回 默认为0不返回 - N |
成员方法
| 函数原型 | 函数作用 |
|---|---|
| string get_url(string host) | 获取接口地址 |
| void add_contents(map contents) | 添加一组内容 |
| void add_content(mixed key, string content) | 添加内容 |
| string gen_sign_text(string key) | 生成待签名文本 |
| LtResult new_result() | 生成请求结果的实例 |
LtSwordPatrolRequest
继承自 LtRequest
全文本敏感词检测+巡服上报请求 - 聊天场景专用
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| game | string | nil | 可选 | 游戏标识 - Y |
| userId | string | nil | 可选 | 雷霆游戏sid 长度不能超过50 - Y |
| channelNo | string | nil | 可选 | 渠道ID。例如110003：九游；130009：4399 - Y |
| os | int | nil | 可选 | 系统 1:android 2 ios 3 web 4 pc端 - Y |
| roleId | string | nil | 可选 | 角色ID - Y |
| roleName | string | nil | 可选 | 角色昵称 - Y |
| serverId | string | nil | 可选 | 游戏区组 - Y |
| content | string | nil | 可选 | 文本内容 长度小于2000 - Y 仅用于用户发表内容，建议对内容中JSON、表情符,回车，换行、HTML标签、 UBB标签等做过滤，只传递纯文本，以减少误判概率 |
| isYd | int | nil | 可选 | 默认 填 2 - Y |
| channel | string | nil | 可选 | 发言频道 - Y 如 世界、私聊等 |
| isFakeForbid | bool | nil | 可选 | 是否为伪禁言 true false - Y |
| speakTime | string | nil | 可选 | 发言时间 yyyy-MM-dd HH:mm:ss - Y |
| money | int | nil | 可选 | 玩家充值金额 - Y |
| roleLevel | string | nil | 可选 | 游戏等级 - N |
| ip | string | nil | 可选 | 玩家客户端IP地址 |
| isReplace | int | nil | 可选 | 是否将拦截敏感词替换 - N 1替换 0不替换（默认值）特别提醒：会存在三方服务未返回敏感词，从而导致敏感文本无法被替换为*的情况。 |
| userName | string | nil | 可选 | 雷霆用户名 - N |
| imei | string | nil | 可选 | 客户端手机imei - N |
| recvRoleId | string | nil | 可选 | 发言接收方roleId 聊天场景 - N （1对1私聊场景必填） |
| isReturnWord | int | nil | 可选 | 是否将匹配到的敏感词返回 - N 0 不返回 1返回 默认为0不返回 |
| ydSecretId | string | nil | 可选 | 易盾独立产品ID,（问道，一念逍遥，奥比岛必填）- N |
| isVoice | bool | nil | 可选 | 是否为实时语音 - N |
| passPatrol | bool | nil | 可选 | 通过后是否上报巡服，默认为true，无特殊要求不传 - N |
| notPassPatrol | bool | nil | 可选 | 不通过是否上报巡服，默认为false，无特殊要求不传 |
| extend | string | nil | 可选 | 拓展字段，json字符串 - N |
成员方法
| 函数原型 | 函数作用 |
|---|---|
| string get_url(string host) | 获取接口地址 |
| string gen_sign_text(string key) | 生成待签名文本 |
| LtResult new_result() | 生成请求结果的实例 |
LtSwordResult
继承自 LtResult
敏感词检测结果
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|
成员方法
| 函数原型 | 函数作用 |
|---|---|
| bool is_passable() | 检查玩家发言是否通过 |
| bool is_replaced() | 检查玩家发言是否被替换 |
| bool is_intercepted() | 检查玩家发言是否被拦截 |
| string get_text() | 获取文本 |
| bool is_intercepted_by_leiting() | 检查雷霆平台是否拦截 |
| bool is_intercepted_by_yd() | 检查易盾是否拦截 |
LtSwordBatchResult
继承自 LtResult
批处理请求结果
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|
成员方法
| 函数原型 | 函数作用 |
|---|---|
| void init(map dict) | 初始化 |
| LtSwordResult get_result_by_key(mixed key) | 获取结果指定字段值 |
样例
public void pkg_sample()
{
write("sample");
}