用户 (User)

WARNING

消歧义：本节介绍跨平台协议中的用户对象。

• 要了解数据库中的用户，请前往 API > 数据库 > 内置数据结构
• 要了解两者的区别，请前往 API > 术语表 > 用户

类型定义

export interface User {
  id: string
  name: string
  avatar?: string
}

API

bot.getUser(userId)

• userId: string 用户 ID
• 返回值: Promise<User> 用户信息

获取用户信息。

bot.getFriendList(next?)

• next: string 分页令牌
• 返回值: Promise<List<User>> 好友列表

获取机器人的好友列表。

bot.getFriendIter() 内置

• 返回值: AsyncIterable<User> 异步迭代器

获取机器人的好友列表的异步迭代器。

bot.handleFriendRequest(messageId, approve, comment?)

• messageId: string 请求 ID
• approve: boolean 是否通过请求
• comment: string 备注信息
• 返回值: Promise<void>

处理好友请求。

事件

friend-request

• session: Session 会话对象
• 触发方式: emit

接收到新的好友申请时触发。