Karin v1.8.5

主题模式

button 模块 ​

字数
648 字
阅读时间
3 分钟

温馨提示

本文由AI辅助生成，可能存在不准确性。

button模块提供了处理和转换机器人按钮消息的工具函数。

按钮处理函数 ​

buttonHandle ​

根据正则表达式调用注册的按钮处理器，用于生成交互按钮元素。

typescript
import { buttonHandle } from 'node-karin'

/**
 * 调用按钮处理器
 * @param reg 正则表达式字符串
 * @param args 可选参数对象
 * @returns 返回按钮元素数组
 */
const buttons = await buttonHandle('正则表达式', { e: event对象, 其他参数 })

参数：

  • reg - 用于匹配按钮处理器的正则表达式字符串
  • args - 可选参数对象
    • e - 消息事件对象
    • 其他自定义参数

返回值：

返回一个包含ButtonElement或KeyboardElement类型元素的数组

按钮转换函数 ​

karinToQQBot ​

将karin标准格式的按钮转换为QQ官方按钮格式。

typescript
import { karinToQQBot } from 'node-karin'

/**
 * 将karin标准格式的按钮转换为QQ官方按钮
 * @param button karin格式的按钮元素
 * @returns QQ官方按钮数组
 */
const qqButtons = karinToQQBot(karinButton)

参数：

  • button - karin格式的按钮元素（ButtonElement或KeyboardElement类型）

返回值：

返回QQ官方按钮数组格式

qqbotToKarin ​

将QQ官方按钮转换为karin标准格式的按钮文本。

typescript
import { qqbotToKarin } from 'node-karin'

/**
 * 将QQ官方按钮转换为karin标准格式的按钮
 * @param button QQ官方按钮数组（content.rows）
 * @returns karin格式的按钮文本
 */
const karinButtonText = qqbotToKarin(qqbotButtons)

参数：

  • button - QQ官方按钮数组，通常是content.rows

返回值：

返回karin格式的按钮文本字符串

按钮类型定义 ​

以下是按钮相关的主要类型：

typescript
// 按钮元素
interface ButtonElement {
  type: 'button'
  data: ButtonRow
}

// 键盘元素
interface KeyboardElement {
  type: 'keyboard'
  rows: ButtonRow[]
}

// 按钮行
type ButtonRow = ButtonData[]

// 按钮数据
interface ButtonData {
  text?: string       // 按钮文本
  link?: string       // 链接URL
  data?: string       // 按钮数据
  show?: string       // 点击后显示的文本
  style?: number      // 样式（0-4）
  tips?: string       // 不支持时的提示
  callback?: boolean  // 是否为回调按钮
  enter?: boolean     // 点击后是否自动发送
  reply?: boolean     // 点击后是否回复
  admin?: boolean     // 仅管理员可用
  list?: string[]     // 可使用用户ID列表
  role?: string[]     // 可使用角色ID列表
  type?: 0 | 1 | 2    // 按钮类型：0-链接，1-回调，2-普通
}