diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 535bcee1..5c1a2071 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -181,7 +181,7 @@ export default defineConfig({ text: 'Api', items: [ { text: '目录', link: '/api/index' }, - { text: '标准Api', link: '/api/standard' }, + { text: '标准Api', link: '/api/api' }, { text: '联系人相关', link: '/api/contact' }, { text: '消息相关', link: '/api/message' } ] @@ -242,7 +242,7 @@ export default defineConfig({ collapsed: true, items: [ { text: '目录', link: '/api/index' }, - { text: '标准Api', link: '/api/standard' }, + { text: '标准Api', link: '/api/api' }, { text: '联系人相关', link: '/api/contact' }, { text: '消息相关', link: '/api/message' } ] diff --git a/docs/api/api.md b/docs/api/api.md index 8228f3e1..1f102630 100644 --- a/docs/api/api.md +++ b/docs/api/api.md @@ -30,7 +30,7 @@ console.log(data) ``` -## logger +## 打印Bot专属日志 > 方法名: `logger` > 描述: `打印带有Bot前缀带有颜色日志` @@ -122,15 +122,62 @@ https://p.qlogo.cn/gh/1234567890/1234567890/100 ::: +## 发送消息 + +::: warning 注意 +`elements`参数必须为数组,并且每个元素都是由`segment`模块中的方法构建的 +::: + +> 方法名: `SendMessage` +> 描述: `发送群消息、好友消息、频道消息(暂不支持)` +> 参数: `contact` `elements` `retry_count` +> 返回值: `Promise` + +| 参数名称 | 类型 | 参数要求 | 备注 | +| :-----------: | :--------------------------------------: | :------: | :------------------: | +| `contact` | [Contact](./contact.md) | --- | 联系人信息 | +| `elements` | Array\<[elements](../utils/segment.md)\> | --- | 消息元素 | +| `retry_count` | number | --- | 重试次数`(暂未适配)` | + +::: code-group + +```JavaScript [被动事件调用] +const elements = [ + segment.text('hello') +] +e.bot.SendMessage(e.contact, elements) +``` + +```JavaScript [主动事件调用] +const elements = [ + segment.text('hello') +] +Bot.SendMessage(contact, elements) +``` + +```JavaScript [响应] +{ + /** 消息ID */ + message_id: 'string', + /** 消息发送时间戳 可能会不存在 */ + message_time: 'number', + /** 原始结果 QQBot适配器下为数组 其他已知适配器为对象 */ + raw_data?: { + // ... + } +} +``` + +::: + \ No newline at end of file diff --git a/docs/api/contact.md b/docs/api/contact.md index a4f8eb4f..dfbe18f0 100644 --- a/docs/api/contact.md +++ b/docs/api/contact.md @@ -21,6 +21,14 @@ | `stranger` | 陌生人 | | `stranger_from_group` | 群临时会话 | +## 快速构建方法 + +```javascript +const contact = karin.contactGroup('123455678') // 群 +const contact = karin.contactFriend('123455678') // 好友 + +``` + ## 示例 - 在收到事件时,此属性必须存在 @@ -31,15 +39,7 @@ import { segment, Bot } from 'node-karin' const self_id = 123456789 -await Bot.sendMsg( - // 参数1 机器人ID - self_id, - // 参数2 contact - { - scene: 'group', - peer: '123456789', - }, - // 参数3 elements - '这只一条主动消息' -) +const contact = karin.contactGroup('123455678') +await Bot.sendMsg(self_id, contact, '这只一条主动消息') + ```