联系实体（Contact）参考

好友 (Friend)

属性

属性名	类型	描述
bot	Bot	bot 对象
id	number	好友的 qq 号码
nick	string	昵称
remark	string	备注（若不存在备注则返回昵称）
avatarUrl	string	头像下载链接

方法

sendMessage (发送消息)

参数列表：

参数	类型	描述
message	Message	消息对象

返回值：

类型	描述
Message	消息对象，可用于撤回。

sendMessage (发送纯文本消息)

参数列表：

参数	类型	描述
message	string	文本信息内容

返回值：

类型	描述
Message	消息对象，可用于撤回。

nudge (创建一个 "戳一戳" 消息)

参数列表：

参数	类型	描述

delete (删除并屏蔽该好友)

参数列表：

参数	类型	描述

uploadImage (发送图片消息) (此方法来自父类Contact) (无论上传是否成功都不会关闭 resource. 需要调用方手动关闭资源)

参数列表：

参数	类型	描述
resource	ExternalResource

返回值：

类型	描述
Image	消息对象，可用于撤回。

群 (Group)

属性

属性名	类型	描述
bot	Bot	Bot 对象
id	number	群号码
avatarUrl	string	群头像地址
name	string	群名称
owner	Member	群主
settings	GroupSettings	群设置
members	ContactList	群成员列表
botAsMember	Member	Bot 在群内的自身 member 对象
botMuteRemaining	number	Bot 被禁言剩余时长
botPermission	MemberPermission	Bot 在群里的权限

方法

sendMessage (发送消息)

参数列表：

参数	类型	描述
message	Message	消息对象

返回值：

类型	描述
Message	消息对象，可用于撤回。

sendMessage (发送纯文本消息)

参数列表：

参数	类型	描述
message	string	文本消息内容

返回值：

类型	描述
Message	消息对象，可用于撤回。

uploadImage (发送图片消息)

参数列表：

参数	类型	描述
resource	string	本地图片路径

返回值：

类型	描述
Image	消息对象，可用于撤回。

uploadVoice (发送语音消息)

参数列表：

参数	类型	描述
resource	string	本地语音路径

返回值：

类型	描述
Voice	消息对象，可用于撤回。

setEssenceMessage (将一条消息设置为群精华消息)

参数列表：

参数	类型	描述
source	MessageSource	消息源

返回值：

类型	描述
boolean	是否成功

getMembers (获取群所有成员)*

参数列表：无

返回值：

类型	描述
Table of Member	获取到的群成员对象列表

get (获取群成员)*

参数列表：

参数	类型	描述
id	number	群成员 qq 号

返回值：

类型	描述
Member	获取到的群成员对象

getOrFail (获取群成员)* (不存在时抛出 kotlin.NoSuchElementException)

参数列表：

参数	类型	描述
id	number	群成员 qq 号

返回值：

类型	描述
Member	获取到的群成员对象

contains (判断是否包含群成员)

参数列表 (以下任一即可)：

参数	类型	描述
id	number	群成员 qq 号
member	Member	群成员对象

返回值：

类型	描述
boolean	是否包含

quit (退出群)

参数列表：无

返回值：

类型	描述
boolean	是否成功

群成员 (Member)

属性

属性名	类型	描述
id	number	群员的 qq 号码
bot	Bot	bot 对象
group	Group	群员所在群
nick	string	昵称
nameCard	string	群名片
nameCardOrNick	string	群名片或昵称，如果有群名片则为群名片，否则为昵称
specialTitle	string	头衔
isAdministrator	boolean	是否为管理员
isOwner	boolean	是否为群主
isOperator	boolean	是否为群主或管理员
isFriend	boolean	是否为好友
muteTimeRemaining	number	被禁言时长
isMuted	boolean	是否被禁言
permission	MemberPermission	成员权限

方法

mute (禁言)

参数列表：

参数	类型	描述
id	number	禁言时间

unmute (解除禁言)

参数列表：

参数	类型	描述

kick (移除群聊)

参数列表：

参数	类型	描述
reason	string	踢出原因

asFriend (转为 Friend 对象)

返回值：

类型	描述
Friend	转换后的 Friend 对象

sendMessage (发送私聊消息)

参数列表：

参数	类型	描述
message	Message	消息对象

返回值：

类型	描述
Message	消息对象，可用于撤回。

sendImage (发送图片消息)

参数列表：

参数	类型	描述
url	string	图片 URL

返回值：

类型	描述
Message	消息对象，可用于撤回。