AdapterBase

约 3606 字大约 12 分钟

2025-10-13

Karin API Docs / AdapterBase

抽象类: AdapterBase\<T\>

定义于: packages/core/src/adapter/base/index.ts:30

适配器基类一个示例 AdapterBase

继承于

AdapterOneBot

类型参数

T

T = any

实现

AdapterType<T>

构造函数

new AdapterBase<T>(): AdapterBase<T>

定义于: packages/core/src/adapter/base/index.ts:36

AdapterBase<T>

属性

account

account: AccountInfo

定义于: packages/core/src/adapter/base/index.ts:31

账号信息

实现了

AdapterType.account

adapter

adapter: AdapterInfo

定义于: packages/core/src/adapter/base/index.ts:32

适配器信息

实现了

AdapterType.adapter

raw

raw: T

定义于: packages/core/src/adapter/base/index.ts:34

原生方法

实现了

AdapterType.raw

super

super: T

定义于: packages/core/src/adapter/base/index.ts:33

原生方法

实现了

AdapterType.super

访问器

selfId

Getter 签名

get selfId(): string

定义于: packages/core/src/adapter/base/index.ts:58

获取Bot的id

string

实现了

AdapterType.selfId

selfName

Getter 签名

get selfName(): string

定义于: packages/core/src/adapter/base/index.ts:62

获取Bot的name

string

实现了

AdapterType.selfName

方法

createGroupFolder()

createGroupFolder(_groupId, _name): Promise<CreateGroupFolderResponse>

定义于: packages/core/src/adapter/base/index.ts:438

创建群文件夹

参数

_groupId

string

群号

_name

string

文件夹名

Promise<CreateGroupFolderResponse>

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

实现了

AdapterType.createGroupFolder

createResId()

createResId(_contact, _elements): Promise<string>

定义于: packages/core/src/adapter/base/index.ts:203

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

参数

_contact

Contact

目标信息

_elements

NodeElement[]

转发消息元素

Promise<string>

Description

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

实现了

AdapterType.createResId

delGroupFile()

delGroupFile(_groupId, _fileId, _busId): Promise<boolean>

定义于: packages/core/src/adapter/base/index.ts:492

删除群文件

参数

_groupId

string

群号

_fileId

string

文件id

_busId

number

文件类型ID

Promise<boolean>

无返回值

实现了

AdapterType.delGroupFile

delGroupFolder()

delGroupFolder(_groupId, _folderId): Promise<boolean>

定义于: packages/core/src/adapter/base/index.ts:459

删除群文件的文件夹

参数

_groupId

string

群号

_folderId

string

文件夹id

Promise<boolean>

无返回值

实现了

AdapterType.delGroupFolder

downloadFile()

downloadFile(_options?): Promise<DownloadFileResponse>

定义于: packages/core/src/adapter/base/index.ts:428

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

参数

_options?

DownloadFileOptions

下载文件的选项

Promise<DownloadFileResponse>

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

实现了

AdapterType.downloadFile

getAiCharacters()

getAiCharacters(): Promise<GetAiCharactersResponse[]>

定义于: packages/core/src/adapter/base/index.ts:602

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

Promise<GetAiCharactersResponse[]>

声色列表

实现了

AdapterType.getAiCharacters

getAtAllCount()

getAtAllCount(_groupId): Promise<GetAtAllCountResponse>

定义于: packages/core/src/adapter/base/index.ts:537

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

参数

_groupId

string

群号

Promise<GetAtAllCountResponse>

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

实现了

AdapterType.getAtAllCount

getAvatarUrl()

getAvatarUrl(_userId, _size?): Promise<string>

定义于: packages/core/src/adapter/base/index.ts:123

获取头像url

参数

_userId

string

用户ID

_size?

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

0 | 100 | 40 | 140

Promise<string>

头像的url地址

实现了

AdapterType.getAvatarUrl

getCookies()

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

定义于: packages/core/src/adapter/base/index.ts:563

获取 Cookies

参数

_domain

string

The domain to get cookies from

Promise<{ cookie: string; }>

实现了

AdapterType.getCookies

getCredentials()

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

定义于: packages/core/src/adapter/base/index.ts:571

获取 QQ 相关接口凭证

参数

_domain

string

The domain to get credentials from

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

实现了

AdapterType.getCredentials

getCSRFToken()

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

定义于: packages/core/src/adapter/base/index.ts:578

获取 CSRF Token

Promise<{ token: number; }>

实现了

AdapterType.getCSRFToken

getFileUrl()

getFileUrl(_contact, _fileId): Promise<string>

定义于: packages/core/src/adapter/base/index.ts:481

获取文件url

参数

_contact

Contact

目标信息

_fileId

string

文件id

Promise<string>

文件url

实现了

AdapterType.getFileUrl

getForwardMsg()

getForwardMsg(_resId): Promise<MessageResponse[]>

定义于: packages/core/src/adapter/base/index.ts:182

获取合并转发消息

参数

_resId

string

资源ID

Promise<MessageResponse[]>

包含MessageResponse对象的数组

实现了

AdapterType.getForwardMsg

getFriendList()

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

定义于: packages/core/src/adapter/base/index.ts:318

获取好友列表

参数

_refresh?

boolean

是否刷新好友列表

Promise<UserInfo[]>

好友列表数组

实现了

AdapterType.getFriendList

getGroupAvatarUrl()

getGroupAvatarUrl(_groupId, _size?, _history?): Promise<string>

定义于: packages/core/src/adapter/base/index.ts:134

获取群头像url

参数

_groupId

string

群号

_size?

头像大小，默认0

0 | 100 | 40 | 140

_history?

number

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

Promise<string>

头像的url地址

实现了

AdapterType.getGroupAvatarUrl

getGroupFileList()

getGroupFileList(_groupId, _folderId?): Promise<GetGroupFileListResponse>

定义于: packages/core/src/adapter/base/index.ts:511

获取群文件夹下文件列表

参数

_groupId

string

群号

_folderId?

string

文件夹id，空则为根目录

Promise<GetGroupFileListResponse>

返回文件和文件夹的列表

实现了

AdapterType.getGroupFileList

getGroupFileSystemInfo()

getGroupFileSystemInfo(_groupId): Promise<GetGroupFileSystemInfoResponse>

定义于: packages/core/src/adapter/base/index.ts:501

获取群文件系统信息

参数

_groupId

string

群号

Promise<GetGroupFileSystemInfoResponse>

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

实现了

AdapterType.getGroupFileSystemInfo

getGroupHighlights()

getGroupHighlights(_groupId, _page, _pageSize): Promise<GetGroupHighlightsResponse[]>

定义于: packages/core/src/adapter/base/index.ts:193

获取精华消息

参数

_groupId

string

群ID

_page

number

页码

_pageSize

number

每页数量

Promise<GetGroupHighlightsResponse[]>

EssenceMessageBody对象

实现了

AdapterType.getGroupHighlights

getGroupHonor()

getGroupHonor(_groupId): Promise<QQGroupHonorInfo[]>

定义于: packages/core/src/adapter/base/index.ts:369

获取群荣誉信息

参数

_groupId

string

群ID

Promise<QQGroupHonorInfo[]>

群荣誉信息数组

实现了

AdapterType.getGroupHonor

getGroupInfo()

getGroupInfo(_groupId, _noCache?): Promise<GroupInfo>

定义于: packages/core/src/adapter/base/index.ts:328

获取群信息

参数

_groupId

string

群ID

_noCache?

boolean

是否刷新缓存

Promise<GroupInfo>

群信息

实现了

AdapterType.getGroupInfo

getGroupList()

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

定义于: packages/core/src/adapter/base/index.ts:337

获取群列表

参数

_refresh?

boolean

是否刷新好友列表

Promise<GroupInfo[]>

群列表数组

实现了

AdapterType.getGroupList

getGroupMemberInfo()

getGroupMemberInfo(_groupId, _targetId, _refresh?): Promise<GroupMemberInfo>

定义于: packages/core/src/adapter/base/index.ts:349

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

参数

_groupId

string

群ID

_targetId

string

目标用户的ID

_refresh?

boolean

是否刷新缓存

Promise<GroupMemberInfo>

群成员信息

实现了

AdapterType.getGroupMemberInfo

getGroupMemberList()

getGroupMemberList(_groupId, _refresh?): Promise<GroupMemberInfo[]>

定义于: packages/core/src/adapter/base/index.ts:359

获取群成员列表

参数

_groupId

string

群ID

_refresh?

boolean

是否刷新缓存

Promise<GroupMemberInfo[]>

群成员列表数组

实现了

AdapterType.getGroupMemberList

getGroupMuteList()

getGroupMuteList(_groupId): Promise<GetGroupMuteListResponse[]>

定义于: packages/core/src/adapter/base/index.ts:546

获取群被禁言用户列表

参数

_groupId

string

Promise<GetGroupMuteListResponse[]>

返回禁言用户列表

实现了

AdapterType.getGroupMuteList

getHistoryMsg()

获取msgId获取历史消息

参数

目标信息

参数

起始消息ID

参数

获取消息数量默认为1

调用签名

getHistoryMsg(_contact, _startMsgId, _count): Promise<MessageResponse[]>

定义于: packages/core/src/adapter/base/index.ts:155

获取msgId获取历史消息

参数

_contact

Contact

目标信息

_startMsgId

string

起始消息ID

_count

number

获取消息数量默认为1

Promise<MessageResponse[]>

包含历史消息的数组

实现了

AdapterType.getHistoryMsg

调用签名

getHistoryMsg(_contact, _startMsgSeq, _count): Promise<MessageResponse[]>

定义于: packages/core/src/adapter/base/index.ts:164

获取msgSeq获取历史消息

参数

_contact

Contact

目标信息

_startMsgSeq

number

起始消息序列号

_count

number

获取消息数量默认为1

Promise<MessageResponse[]>

包含历史消息的数组

实现了

AdapterType.getHistoryMsg

getMsg()

getMsg(_contact, _messageId?): Promise<MessageResponse>

定义于: packages/core/src/adapter/base/index.ts:144

获取消息

参数

_contact

目标信息

string | Contact

_messageId?

string

消息ID

Promise<MessageResponse>

MessageResponse对象

实现了

AdapterType.getMsg

getNotJoinedGroupInfo()

getNotJoinedGroupInfo(_groupId): Promise<GroupInfo>

定义于: packages/core/src/adapter/base/index.ts:528

获取陌生群信息

参数

_groupId

string

群号

Promise<GroupInfo>

实现了

AdapterType.getNotJoinedGroupInfo

getRkey()

getRkey(): Promise<GetRkeyResponse[]>

定义于: packages/core/src/adapter/base/index.ts:594

获取 rkey

Promise<GetRkeyResponse[]>

rkey

实现了

AdapterType.getRkey

getStrangerInfo()

getStrangerInfo(_targetId): Promise<UserInfo>

定义于: packages/core/src/adapter/base/index.ts:309

获取陌生人信息此接口数据无法保证完全正确并且无法保证数据的完整性

参数

_targetId

string

用户ID 任选其一

Promise<UserInfo>

陌生人信息数组

实现了

AdapterType.getStrangerInfo

groupKickMember()

groupKickMember(_groupId, _targetId, _rejectAddRequest?, _kickReason?): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:233

群踢人

参数

_groupId

string

群ID

_targetId

string

被踢出目标的ID 任选其一

_rejectAddRequest?

boolean

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

_kickReason?

string

踢出原因，可选

Promise<void>

实现了

AdapterType.groupKickMember

logger()

logger(level, ...args): void

定义于: packages/core/src/adapter/base/index.ts:75

打印当前Bot的专属日志

参数

level

LogMethodNames

日志等级

args

...any[]

日志内容

void

实现了

AdapterType.logger

pokeUser()

pokeUser(_contact, _count?): Promise<boolean>

定义于: packages/core/src/adapter/base/index.ts:555

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

参数

_contact

Contact

目标信息

_count?

number

戳一戳次数默认为1

Promise<boolean>

实现了

AdapterType.pokeUser

recallMsg()

recallMsg(_contact, _messageId): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:113

撤回消息

参数

_contact

Contact

目标信息

_messageId

string

消息ID

Promise<void>

实现了

AdapterType.recallMsg

renameGroupFolder()

renameGroupFolder(_groupId, _folderId, _name): Promise<boolean>

定义于: packages/core/src/adapter/base/index.ts:449

重命名群文件的文件夹

参数

_groupId

string

群号

_folderId

string

文件夹id

_name

string

文件夹名

Promise<boolean>

无返回值

实现了

AdapterType.renameGroupFolder

selfSubId()

selfSubId(key): string

定义于: packages/core/src/adapter/base/index.ts:66

获取Bot的subId

参数

key

string

子ID的key

string

实现了

AdapterType.selfSubId

sendAiCharacter()

sendAiCharacter(_groupId, _characterId, _text): Promise<{ messageId: string; }>

定义于: packages/core/src/adapter/base/index.ts:613

设置群 Ai 语音声色

参数

_groupId

string

群号

_characterId

string

声色ID

_text

string

文本

Promise<{ messageId: string; }>

是否设置成功

实现了

AdapterType.sendAiCharacter

sendForwardMsg()

sendForwardMsg(_contact, _elements, _options?): Promise<{ forwardId: string; messageId: string; }>

定义于: packages/core/src/adapter/base/index.ts:104

发送合并转发消息

参数

_contact

Contact

目标信息

_elements

NodeElement[]

消息元素

_options?

ForwardOptions

首层小卡片外显参数

Promise<{ forwardId: string; messageId: string; }>

实现了

AdapterType.sendForwardMsg

sendLike()

sendLike(_targetId, _count): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:222

发送好友赞

参数

_targetId

string

目标ID

_count

number

赞的次数

Promise<void>

实现了

AdapterType.sendLike

sendLongMsg()

sendLongMsg(_contact, _resId): Promise<SendMsgResults>

定义于: packages/core/src/adapter/base/index.ts:94

发送长消息

参数

_contact

Contact

目标信息

_resId

string

资源ID

Promise<SendMsgResults>

实现了

AdapterType.sendLongMsg

sendMsg()

sendMsg(_contact, _elements, _retryCount?): Promise<SendMsgResults>

定义于: packages/core/src/adapter/base/index.ts:85

发送消息

参数

_contact

Contact

目标信息

_elements

Elements[]

消息元素

_retryCount?

number

重试次数默认为0

Promise<SendMsgResults>

实现了

AdapterType.sendMsg

setAvatar()

setAvatar(_file): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:586

设置头像

参数

_file

string

Promise<void>

实现了

AdapterType.setAvatar

setFriendApplyResult()

setFriendApplyResult(_requestId, _isApprove, _remark?): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:379

设置好友请求结果

参数

_requestId

string

请求事件ID

_isApprove

boolean

是否同意

_remark?

string

好友备注同意时有效

Promise<void>

实现了

AdapterType.setFriendApplyResult

setGroupAdmin()

setGroupAdmin(_groupId, _targetId, _isAdmin): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:262

设置群管理员

参数

_groupId

string

群ID

_targetId

string

目标用户的ID

_isAdmin

boolean

是否设置为管理员

Promise<void>

实现了

AdapterType.setGroupAdmin

setGroupAllMute()

setGroupAllMute(_groupId, _isBan): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:252

群全员禁言

参数

_groupId

string

群ID

_isBan

boolean

是否开启全员禁言

Promise<void>

实现了

AdapterType.setGroupAllMute

setGroupApplyResult()

setGroupApplyResult(_requestId, _isApprove, _denyReason?): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:389

设置申请加入群请求结果

参数

_requestId

string

请求事件ID

_isApprove

boolean

是否同意

_denyReason?

string

拒绝理由拒绝时有效

Promise<void>

实现了

AdapterType.setGroupApplyResult

setGroupHighlights()

setGroupHighlights(_groupId, _messageId, _create): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:213

设置、取消群精华消息

参数

_groupId

string

群ID

_messageId

string

群消息ID

_create

boolean

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

Promise<void>

实现了

AdapterType.setGroupHighlights

setGroupMemberCard()

setGroupMemberCard(_groupId, _targetId, _card): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:272

设置群名片

参数

_groupId

string

群ID

_targetId

string

目标用户的ID

_card

string

新的群名片

Promise<void>

实现了

AdapterType.setGroupMemberCard

setGroupMemberTitle()

setGroupMemberTitle(_groupId, _targetId, _title): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:300

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

参数

_groupId

string

群ID

_targetId

string

目标用户的ID

_title

string

新的专属头衔

Promise<void>

实现了

AdapterType.setGroupMemberTitle

setGroupMute()

setGroupMute(_groupId, _targetId, _duration): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:243

禁言群成员

参数

_groupId

string

群ID

_targetId

string

被禁言目标的ID 任选其一

_duration

number

禁言时长单位:秒

Promise<void>

实现了

AdapterType.setGroupMute

setGroupName()

setGroupName(_groupId, _groupName): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:281

设置群名

参数

_groupId

string

群ID

_groupName

string

新的群名

Promise<void>

实现了

AdapterType.setGroupName

setGroupQuit()

setGroupQuit(_groupId, _isDismiss): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:290

退出群组

参数

_groupId

string

群ID

_isDismiss

boolean

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

Promise<void>

实现了

AdapterType.setGroupQuit

setGroupRemark()

setGroupRemark(_groupId, _remark): Promise<boolean>

定义于: packages/core/src/adapter/base/index.ts:520

设置群备注

参数

_groupId

string

群号

_remark

string

新的备注

Promise<boolean>

实现了

AdapterType.setGroupRemark

setInvitedJoinGroupResult()

setInvitedJoinGroupResult(_requestId, _isApprove): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:398

设置邀请加入群请求结果

参数

_requestId

string

请求事件ID

_isApprove

boolean

是否同意

Promise<void>

实现了

AdapterType.setInvitedJoinGroupResult

setMsgReaction()

setMsgReaction(_contact, _messageId, _faceId, _isSet): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:408

设置消息表情回应

参数

_contact

Contact

目标信息

_messageId

string

消息ID

_faceId

表情ID

string | number

_isSet

boolean

Promise<void>

实现了

AdapterType.setMsgReaction

uploadFile()

uploadFile(_contact, _file, _name, _folder?): Promise<void>

定义于: packages/core/src/adapter/base/index.ts:419

上传群文件、私聊文件

参数

_contact

Contact

目标信息

_file

string

本地文件绝对路径

_name

string

文件名称必须提供

_folder?

string

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

Promise<void>

实现了

AdapterType.uploadFile

uploadGroupFile()

uploadGroupFile(_groupId, _file, _name?): Promise<boolean>

定义于: packages/core/src/adapter/base/index.ts:471

上传群文件

参数

_groupId

string

群号

_file

string

文件绝对路径

_name?

string

文件名

Promise<boolean>

无返回值

Description

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

实现了

AdapterType.uploadGroupFile

命名空间

common

接口

类型别名

变量

函数

config

变量

函数

segment

函数

枚举

类

接口

类型别名

变量

函数

AdapterBase