Bot 接口:所有平台 bot 的统一操作面。 除 bot_id / adapter / sendMessage / sendApi / as 外, 其余方法由框架按能力自动绑定(见 bindCapabilities)。
Properties
adapter
readonlyadapter:string
bot_id
readonlybot_id:string
connected_at?
readonlyoptionalconnected_at?:number
nickname?
readonlyoptionalnickname?:string
online
readonlyonline:boolean
Methods
as()
as<
T>():T
按目标类型断言 bot,用于访问平台特有方法
Type Parameters
T
T extends object = Record<string, unknown>
Returns
T
banMember()
banMember(
group_id,user_id,duration):Promise<void>
duration 单位为秒,0 = 解除禁言
Parameters
group_id
user_id
duration
number
Returns
Promise<void>
deleteFriend()
deleteFriend(
user_id):Promise<void>
Parameters
user_id
Returns
Promise<void>
getAvatar()
getAvatar():
Promise<string|null>
获取 bot 头像地址;平台不支持或取不到时返回 null
Returns
Promise<string | null>
getForwardMessage()
getForwardMessage(
message_id):Promise<ForwardNode[]>
Parameters
message_id
Returns
Promise<ForwardNode[]>
getFriendInfo()
getFriendInfo(
user_id):Promise<FriendInfo|null>
Parameters
user_id
Returns
Promise<FriendInfo | null>
getFriendList()
getFriendList():
Promise<FriendInfo[]>
Returns
Promise<FriendInfo[]>
getGroupInfo()
getGroupInfo(
group_id):Promise<GroupInfo|null>
Parameters
group_id
Returns
Promise<GroupInfo | null>
getGroupList()
getGroupList():
Promise<GroupInfo[]>
Returns
Promise<GroupInfo[]>
getGroupMembers()
getGroupMembers(
group_id):Promise<MemberInfo[]>
Parameters
group_id
Returns
Promise<MemberInfo[]>
getHistory()
getHistory(
target,before?,limit?,extra?):Promise<HistoryMessage[]>
拉取会话历史,before 为上一页的消息 id
Parameters
target
before?
string
limit?
number
extra?
Record<string, unknown>
Returns
Promise<HistoryMessage[]>
getMemberInfo()
getMemberInfo(
group_id,user_id):Promise<MemberInfo|null>
Parameters
group_id
user_id
Returns
Promise<MemberInfo | null>
getMessage()
getMessage(
message_id):Promise<MessageGetResult|null>
Parameters
message_id
Returns
Promise<MessageGetResult | null>
getStatus()
getStatus():
Promise<BotStatusResult>
Returns
Promise<BotStatusResult>
kickMember()
kickMember(
group_id,user_id,reject_add_request?):Promise<void>
reject_add_request 为 true 时同时拒绝该成员后续的加群申请
Parameters
group_id
user_id
reject_add_request?
boolean
Returns
Promise<void>
leaveGroup()
leaveGroup(
group_id,is_dismiss?):Promise<void>
is_dismiss 为 true 时解散群(仅群主可用)
Parameters
group_id
is_dismiss?
boolean
Returns
Promise<void>
pokeMember()
pokeMember(
group_id,user_id):Promise<void>
Parameters
group_id
user_id
Returns
Promise<void>
recallMessage()
recallMessage(
message_id):Promise<void>
Parameters
message_id
Returns
Promise<void>
sendApi()
sendApi<
T>(action,params?):Promise<T>
直接调用平台原生 API(action 为平台动作名)
Type Parameters
T
T = unknown
Parameters
action
string
params?
Record<string, unknown>
Returns
Promise<T>
sendForward()
sendForward(
target,nodes,options?):Promise<SentMessage>
Parameters
target
nodes
readonly ForwardSendNode[]
options?
Returns
Promise<SentMessage>
sendGroupMsg()
sendGroupMsg(
group_id,message):Promise<SentMessage>
Parameters
group_id
message
Returns
Promise<SentMessage>
sendMessage()
sendMessage(
target,message):Promise<SentMessage>
Parameters
target
message
Returns
Promise<SentMessage>
sendPrivateMsg()
sendPrivateMsg(
user_id,message):Promise<SentMessage>
Parameters
user_id
message
Returns
Promise<SentMessage>
setAvatar()
setAvatar(
file):Promise<void>
file 为本地路径或 URL
Parameters
file
string
Returns
Promise<void>
setGroupName()
setGroupName(
group_id,group_name):Promise<void>
Parameters
group_id
group_name
string
Returns
Promise<void>
setGroupPortrait()
setGroupPortrait(
group_id,file):Promise<void>
Parameters
group_id
file
string
Returns
Promise<void>
setGroupWholeBan()
setGroupWholeBan(
group_id,enable):Promise<void>
Parameters
group_id
enable
boolean
Returns
Promise<void>
setMemberAdmin()
setMemberAdmin(
group_id,user_id,enable):Promise<void>
Parameters
group_id
user_id
enable
boolean
Returns
Promise<void>
setMemberCard()
setMemberCard(
group_id,user_id,card):Promise<void>
Parameters
group_id
user_id
card
string
Returns
Promise<void>
setMemberTitle()
setMemberTitle(
group_id,user_id,title):Promise<void>
Parameters
group_id
user_id
title
string
Returns
Promise<void>
setProfile()
setProfile(
profile):Promise<void>
Parameters
profile
Returns
Promise<void>
