Karin API Docs / AdapterType

接口: AdapterType\<T\>

定义于: packages/core/src/types/adapter/class.ts:26

适配器类型

类型参数

T

T = any

属性

account

account: AccountInfo

定义于: packages/core/src/types/adapter/class.ts:43

账号信息

---

adapter

adapter: AdapterInfo

定义于: packages/core/src/types/adapter/class.ts:40

适配器信息

---

raw

raw: T

定义于: packages/core/src/types/adapter/class.ts:30

原生方法

---

sendApi()?

optional sendApi: (...args) => Promise<any>

定义于: packages/core/src/types/adapter/class.ts:37

onebot专属方法

参数

args

...any[]

返回

Promise<any>

---

super

super: T

定义于: packages/core/src/types/adapter/class.ts:28

原生方法

访问器

selfId

Getter 签名

get selfId(): string

定义于: packages/core/src/types/adapter/class.ts:46

获取Bot的id

返回

string

---

selfName

Getter 签名

get selfName(): string

定义于: packages/core/src/types/adapter/class.ts:48

获取Bot的name

返回

string

方法

createGroupFolder()

createGroupFolder(groupId, name): Promise<CreateGroupFolderResponse>

定义于: packages/core/src/types/adapter/class.ts:361

创建群文件夹

参数

groupId

string

群号

name

string

文件夹名

返回

Promise<CreateGroupFolderResponse>

返回文件夹id和已使用空间

---

createResId()

createResId(contact, elements): Promise<string>

定义于: packages/core/src/types/adapter/class.ts:167

构造一个资源ID 即上传合并转发消息后不进行发送

参数

contact

Contact

目标信息

elements

NodeElement[]

转发消息元素

返回

Promise<string>

Description

此接口并不是所有协议端都支持的，因此在使用时请注意

---

delGroupFile()

delGroupFile(groupId, fileId, busId): Promise<boolean>

定义于: packages/core/src/types/adapter/class.ts:397

删除群文件

参数

groupId

string

群号

fileId

string

文件id

busId

number

文件类型ID

返回

Promise<boolean>

无返回值

---

delGroupFolder()

delGroupFolder(groupId, folderId): Promise<boolean>

定义于: packages/core/src/types/adapter/class.ts:378

删除群文件的文件夹

参数

groupId

string

群号

folderId

string

文件夹id

返回

Promise<boolean>

无返回值

---

downloadFile()

downloadFile(options?): Promise<DownloadFileResponse>

定义于: packages/core/src/types/adapter/class.ts:345

让协议端下载文件到协议端本地

参数

options?

DownloadFileOptions

下载文件的选项

返回

Promise<DownloadFileResponse>

下载文件的绝对路径和文件MD5

---

getAiCharacters()

getAiCharacters(): Promise<GetAiCharactersResponse[]>

定义于: packages/core/src/types/adapter/class.ts:477

获取群 Ai 语音可用声色列表

返回

Promise<GetAiCharactersResponse[]>

声色列表

---

getAtAllCount()

getAtAllCount(groupId): Promise<GetAtAllCountResponse>

定义于: packages/core/src/types/adapter/class.ts:432

获取艾特全体成员剩余次数

参数

groupId

string

群号

返回

Promise<GetAtAllCountResponse>

返回是否允许at全体成员和全群剩余次数、个人剩余次数

---

getAvatarUrl()

getAvatarUrl(userId, size?): Promise<string>

定义于: packages/core/src/types/adapter/class.ts:99

获取头像url

参数

userId

string

用户ID

size?

头像大小，默认需要为0，请开发者注意

0 | 100 | 40 | 140

返回

Promise<string>

头像的url地址

---

getCookies()

getCookies(domain): Promise<{ cookie: string; }>

定义于: packages/core/src/types/adapter/class.ts:453

获取 Cookies

参数

domain

string

The domain to get cookies from

返回

Promise<{ cookie: string; }>

---

getCredentials()

getCredentials(domain): Promise<{ cookies: string; csrf_token: number; }>

定义于: packages/core/src/types/adapter/class.ts:459

获取 QQ 相关接口凭证

参数

domain

string

The domain to get credentials from

返回

Promise<{ cookies: string; csrf_token: number; }>

---

getCSRFToken()

getCSRFToken(): Promise<{ token: number; }>

定义于: packages/core/src/types/adapter/class.ts:464

获取 CSRF Token

返回

Promise<{ token: number; }>

---

getFileUrl()

getFileUrl(contact, fileId): Promise<string>

定义于: packages/core/src/types/adapter/class.ts:353

获取文件url

参数

contact

Contact

目标信息

fileId

string

文件id

返回

Promise<string>

文件url

---

getForwardMsg()

getForwardMsg(resId): Promise<MessageResponse[]>

定义于: packages/core/src/types/adapter/class.ts:150

获取合并转发消息

参数

resId

string

资源ID

返回

Promise<MessageResponse[]>

包含MessageResponse对象的数组

---

getFriendList()

getFriendList(refresh?): Promise<UserInfo[]>

定义于: packages/core/src/types/adapter/class.ts:257

获取好友列表

参数

refresh?

boolean

是否刷新好友列表

返回

Promise<UserInfo[]>

好友列表数组

---

getGroupAvatarUrl()

getGroupAvatarUrl(groupId, size?, history?): Promise<string>

定义于: packages/core/src/types/adapter/class.ts:108

获取群头像url

参数

groupId

string

群号

size?

头像大小，默认0

0 | 100 | 40 | 140

history?

number

历史头像记录，默认0，若要获取历史群头像则填写1,2,3...

返回

Promise<string>

头像的url地址

---

getGroupFileList()

getGroupFileList(groupId, folderId?): Promise<GetGroupFileListResponse>

定义于: packages/core/src/types/adapter/class.ts:412

获取群文件夹下的文件列表

参数

groupId

string

群号

folderId?

string

文件夹id，空则为根目录

返回

Promise<GetGroupFileListResponse>

返回文件和文件夹的列表

---

getGroupFileSystemInfo()

getGroupFileSystemInfo(groupId): Promise<GetGroupFileSystemInfoResponse>

定义于: packages/core/src/types/adapter/class.ts:404

获取群文件系统信息

参数

groupId

string

群号

返回

Promise<GetGroupFileSystemInfoResponse>

返回文件数量、文件数量上限、已使用空间和空间上限

---

getGroupHighlights()

getGroupHighlights(groupId, page, pageSize): Promise<GetGroupHighlightsResponse[]>

定义于: packages/core/src/types/adapter/class.ts:159

获取精华消息

参数

groupId

string

群ID

page

number

页码

pageSize

number

每页数量

返回

Promise<GetGroupHighlightsResponse[]>

EssenceMessageBody对象

---

getGroupHonor()

getGroupHonor(groupId): Promise<QQGroupHonorInfo[]>

定义于: packages/core/src/types/adapter/class.ts:297

获取群荣誉信息

参数

groupId

string

群ID

返回

Promise<QQGroupHonorInfo[]>

群荣誉信息数组

---

getGroupInfo()

getGroupInfo(groupId, noCache?): Promise<GroupInfo>

定义于: packages/core/src/types/adapter/class.ts:265

获取群信息

参数

groupId

string

群ID

noCache?

boolean

是否刷新缓存

返回

Promise<GroupInfo>

群信息

---

getGroupList()

getGroupList(refresh?): Promise<GroupInfo[]>

定义于: packages/core/src/types/adapter/class.ts:272

获取群列表

参数

refresh?

boolean

是否刷新好友列表

返回

Promise<GroupInfo[]>

群列表数组

---

getGroupMemberInfo()

getGroupMemberInfo(groupId, targetId, refresh?): Promise<GroupMemberInfo>

定义于: packages/core/src/types/adapter/class.ts:282

获取群成员信息 此接口在非QQ平台上很难获取到标准信息，因此返回的数据可能会有所不同

参数

groupId

string

群ID

targetId

string

目标用户的ID

refresh?

boolean

是否刷新缓存

返回

Promise<GroupMemberInfo>

群成员信息

---

getGroupMemberList()

getGroupMemberList(groupId, refresh?): Promise<GroupMemberInfo[]>

定义于: packages/core/src/types/adapter/class.ts:290

获取群成员列表

参数

groupId

string

群ID

refresh?

boolean

是否刷新缓存

返回

Promise<GroupMemberInfo[]>

群成员列表数组

---

getGroupMuteList()

getGroupMuteList(groupId): Promise<GetGroupMuteListResponse[]>

定义于: packages/core/src/types/adapter/class.ts:439

获取群被禁言用户列表

参数

groupId

string

返回

Promise<GetGroupMuteListResponse[]>

返回禁言用户列表

---

getHistoryMsg()

调用签名

getHistoryMsg(contact, startMsgSeq, count): Promise<MessageResponse[]>

定义于: packages/core/src/types/adapter/class.ts:133

获取msgId获取历史消息

参数

contact

Contact

目标信息

startMsgSeq

number

起始消息序列号

count

number

获取消息数量 默认为1

返回

Promise<MessageResponse[]>

包含历史消息的数组

调用签名

getHistoryMsg(contact, startMsgId, count): Promise<MessageResponse[]>

定义于: packages/core/src/types/adapter/class.ts:142

获取msgId获取历史消息

参数

contact

Contact

目标信息

startMsgId

string

起始消息ID

count

number

获取消息数量 默认为1

返回

Promise<MessageResponse[]>

包含历史消息的数组

---

getMsg()

调用签名

getMsg(messageId): Promise<MessageResponse>

定义于: packages/core/src/types/adapter/class.ts:116

获取消息

参数

messageId

string

消息ID

返回

Promise<MessageResponse>

MessageResponse对象

调用签名

getMsg(contact, messageId): Promise<MessageResponse>

定义于: packages/core/src/types/adapter/class.ts:124

获取消息

参数

contact

Contact

目标信息

messageId

string

消息ID

返回

Promise<MessageResponse>

MessageResponse对象

---

getNotJoinedGroupInfo()?

optional getNotJoinedGroupInfo(groupId): Promise<GroupInfo>

定义于: packages/core/src/types/adapter/class.ts:425

获取陌生群信息

参数

groupId

string

群号

返回

Promise<GroupInfo>

---

getRkey()

getRkey(): Promise<GetRkeyResponse[]>

定义于: packages/core/src/types/adapter/class.ts:492

获取 rkey

返回

Promise<GetRkeyResponse[]>

rkey

---

getStrangerInfo()

getStrangerInfo(targetId): Promise<UserInfo>

定义于: packages/core/src/types/adapter/class.ts:250

获取陌生人信息

参数

targetId

string

用户ID 任选其一

返回

Promise<UserInfo>

陌生人信息数组

---

groupKickMember()

groupKickMember(groupId, targetId, rejectAddRequest?, kickReason?): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:191

群踢人

参数

groupId

string

群ID

targetId

string

被踢出目标的ID 任选其一

rejectAddRequest?

boolean

是否拒绝再次申请，默认为false

kickReason?

string

踢出原因，可选

返回

Promise<void>

---

logger()

logger(level, ...args): void

定义于: packages/core/src/types/adapter/class.ts:61

打印当前Bot的专属日志

参数

level

LoggerLevel

日志等级

args

...any[]

日志内容

返回

void

---

pokeUser()

pokeUser(contact, targetId, count?): Promise<boolean>

定义于: packages/core/src/types/adapter/class.ts:447

戳一戳用户 支持群聊和私聊

参数

contact

Contact

目标信息

targetId

string

被戳用户 ID

count?

number

戳一戳次数 默认为1

返回

Promise<boolean>

---

recallMsg()

recallMsg(contact, messageId): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:91

撤回消息

参数

contact

Contact

目标信息

messageId

string

消息ID

返回

Promise<void>

---

renameGroupFolder()

renameGroupFolder(groupId, folderId, name): Promise<boolean>

定义于: packages/core/src/types/adapter/class.ts:370

重命名群文件的文件夹

参数

groupId

string

群号

folderId

string

文件夹id

name

string

文件夹名

返回

Promise<boolean>

无返回值

---

selfSubId()

selfSubId(key): string

定义于: packages/core/src/types/adapter/class.ts:54

获取Bot的subId

参数

key

string

子ID的key

返回

string

---

sendAiCharacter()

sendAiCharacter(group_id, character, text): Promise<{ messageId: string; }>

定义于: packages/core/src/types/adapter/class.ts:486

发送群 Ai 语音声色

参数

group_id

string

群号

character

string

text

string

转换的文本

返回

Promise<{ messageId: string; }>

是否设置成功

---

sendForwardMsg()

sendForwardMsg(contact, elements, options?): Promise<{ messageId: string; }>

定义于: packages/core/src/types/adapter/class.ts:84

发送合并转发消息

参数

contact

Contact

目标信息

elements

NodeElement[]

消息元素

options?

ForwardOptions

首层小卡片外显参数

返回

Promise<{ messageId: string; }>

---

sendLike()

sendLike(targetId, count): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:182

发送好友赞

参数

targetId

string

目标ID

count

number

赞的次数，默认为10

返回

Promise<void>

---

sendLongMsg()

sendLongMsg(contact, resId): Promise<SendMsgResults>

定义于: packages/core/src/types/adapter/class.ts:76

发送长消息

参数

contact

Contact

目标信息

resId

string

资源ID

返回

Promise<SendMsgResults>

---

sendMsg()

sendMsg(contact, elements, retryCount?): Promise<SendMsgResults>

定义于: packages/core/src/types/adapter/class.ts:69

发送消息

参数

contact

Contact

目标信息

elements

SendElement[]

消息元素

retryCount?

number

重试次数 默认为0

返回

Promise<SendMsgResults>

---

setAvatar()

setAvatar(file): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:471

设置头像

参数

file

string

base64:// file:// http(s)😕/

返回

Promise<void>

是否设置成功

---

setFriendApplyResult()

setFriendApplyResult(requestId, isApprove, remark?): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:306

设置好友请求结果

参数

requestId

string

请求事件ID

isApprove

boolean

是否同意

remark?

string

好友备注 同意时有效

返回

Promise<void>

设置结果

---

setGroupAdmin()

setGroupAdmin(groupId, targetId, isAdmin): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:213

设置群管理员

参数

groupId

string

群ID

targetId

string

目标用户的ID

isAdmin

boolean

是否设置为管理员

返回

Promise<void>

---

setGroupAllMute()

setGroupAllMute(groupId, isBan): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:205

群全员禁言

参数

groupId

string

群ID

isBan

boolean

是否开启全员禁言

返回

Promise<void>

---

setGroupApplyResult()

setGroupApplyResult(requestId, isApprove, denyReason?): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:314

设置申请加入群请求结果

参数

requestId

string

请求事件ID

isApprove

boolean

是否同意

denyReason?

string

拒绝理由 拒绝时有效

返回

Promise<void>

---

setGroupHighlights()

setGroupHighlights(groupId, messageId, create): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:175

设置、取消群精华消息

参数

groupId

string

群ID

messageId

string

群消息ID

create

boolean

true为添加精华消息，false为删除精华消息 默认为true

返回

Promise<void>

---

setGroupMemberCard()

setGroupMemberCard(groupId, targetId, card): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:221

设置群名片

参数

groupId

string

群ID

targetId

string

目标用户的ID

card

string

新的群名片

返回

Promise<void>

---

setGroupMemberTitle()

setGroupMemberTitle(groupId, targetId, title): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:243

设置群专属头衔 仅群主可用

参数

groupId

string

群ID

targetId

string

目标用户的ID

title

string

新的专属头衔

返回

Promise<void>

---

setGroupMute()

setGroupMute(groupId, targetId, duration): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:199

禁言群成员

参数

groupId

string

群ID

targetId

string

被禁言目标的ID 任选其一

duration

number

禁言时长 单位:秒

返回

Promise<void>

---

setGroupName()

setGroupName(groupId, groupName): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:228

设置群名

参数

groupId

string

群ID

groupName

string

新的群名

返回

Promise<void>

---

setGroupQuit()

setGroupQuit(groupId, isDismiss): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:235

退出群组

参数

groupId

string

群ID

isDismiss

boolean

如果Bot是群主，是否解散群

返回

Promise<void>

---

setGroupRemark()

setGroupRemark(groupId, remark): Promise<boolean>

定义于: packages/core/src/types/adapter/class.ts:419

设置群备注

参数

groupId

string

群号

remark

string

新的备注

返回

Promise<boolean>

---

setInvitedJoinGroupResult()

setInvitedJoinGroupResult(requestId, isApprove): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:321

设置邀请加入群请求结果

参数

requestId

string

请求事件ID

isApprove

boolean

是否同意

返回

Promise<void>

---

setMsgReaction()

setMsgReaction(contact, messageId, faceId, isSet): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:329

设置消息表情回应

参数

contact

Contact

目标信息

messageId

string

消息ID

faceId

表情ID

string | number

isSet

boolean

返回

Promise<void>

---

uploadFile()

uploadFile(contact, file, name, folder?): Promise<void>

定义于: packages/core/src/types/adapter/class.ts:338

上传群文件、私聊文件

参数

contact

Contact

目标信息

file

string

本地文件绝对路径

name

string

文件名称 必须提供

folder?

string

父目录ID 不提供则上传到根目录 仅在群聊时有效

返回

Promise<void>

---

uploadGroupFile()

uploadGroupFile(groupId, file, name?): Promise<boolean>

定义于: packages/core/src/types/adapter/class.ts:388

上传群文件

参数

groupId

string

群号

file

string

文件绝对路径

name?

string

文件名

返回

Promise<boolean>

无返回值

Description

此接口仅可以在Bot和协议端在同一台设备上时使用