通讯录好友相关接口

更新时间: 2024/08/12 14:47:11

通讯录好友相关接口提供通讯录相关操作的功能。

ContactKit-UI 模块

通讯录模块(ContactKit-UI)主要包含好友、用户、黑名单等相关接口。

方法列表

接口 接口原型 接口描述
addBlockList addBlockList(accountId: String, callback: FetchCallback<Void?>?) 添加到黑名单。
addContactListener addContactListener(listener: ContactListener) 添加一个联系人状态变化监听。
addFriend addFriend(accountId: String, mode: V2NIMFriendAddMode? = V2NIMFriendAddMode.V2NIM_FRIEND_MODE_TYPE_APPLY, postscript: String? = null, callback: FetchCallback<Void?>?) 添加好友。
addFriendApplicationCountListener addFriendApplicationCountListener(listener: FriendApplicationCountListener) 注册一个未读好友申请数量变化监听。
clearNotification clearNotification() 清空通知 现在还只能用 V1 的接口实现。
deleteFriend deleteFriend(account: String, deleteAlias: Boolean = true, callback: FetchCallback<Void?>?) 删除好友。
getBlockList getBlockList(callback: FetchCallback<List>?) 获取黑名单列表。
getContactList getContactList(clearCache: Boolean = false, callback: FetchCallback<List>?) 获取通讯录列表数据,我的好友信息(去除黑名单中好友)。
getFriendInfoList getFriendInfoList(accountIds: List<String>, callback: FetchCallback<List>?) 根据 AccountId 获取好友信息 如果不是好友,UserWithFriend 中的 friend 为 null。
getFriendInfoListCoroutine getFriendInfoListCoroutine(accountIds: List<String>): List 根据 AccountId 获取好友信息(挂起)。
getFriendList getFriendList(callback: FetchCallback<List?>) 获取好友列表。
getFriendUserInfo getFriendUserInfo(accountId: String, userCache: Boolean = false, callback: FetchCallback) 根据账号 ID,查询账号 ID 对应的好友信息,包括昵称、头像等数据。
getNotificationList getNotificationList(offset: Long, limit: Int, callback: FetchCallback<FriendAddApplicationResult?>) 获取好友申请列表。
getUnreadApplicationCount getUnreadApplicationCount(callback: FetchCallback<Int>?) 获取未读好友申请数量。
getUserInfo getUserInfo(accountIds: List<String>, callback: FetchCallback<List>?) 根据 AccountId 获取用户信息,本地查询。
getUserListFromCloud getUserListFromCloud(accountIds: List<String>, callback: FetchCallback<List>?) 根据 AccountId 获取用户信息,远端拉取。
isBlockList isBlockList(accountId: String): Boolean 根据账号 ID,查询账号是否在黑名单中。
isFriend isFriend(accountId: String): Boolean 是否为好友。
removeBlockList removeBlockList(accountId: String, callback: FetchCallback<Void?>?) 从黑名单中移除。
removeContactListener removeContactListener(listener: ContactListener?) 删除一个联系人状态变化监听。
removeFriendApplicationCountListener removeFriendApplicationCountListener(listener: FriendApplicationCountListener) 删除一个未读好友申请数量变化监听。
setAddApplicationRead setAddApplicationRead(callback: FetchCallback<Void?>?) 重置未读数。
updateAlias updateAlias(account: String, alias: String?, callback: FetchCallback<Void?>?) 更新好友备注。
updateSelfUserProfile updateSelfUserProfile(updateParams: V2NIMUserUpdateParams, callback: FetchCallback<Void?>?) 更新当前账号的用户信息。
此文档是否对你有帮助?
有帮助
去反馈
  • ContactKit-UI 模块
  • 方法列表