com.netease.nimlib.sdk.friend

接口 FriendService

public interface FriendService

好友管理/好友关系/黑名单关系/消息提醒相关操作

方法概要

限定符和类型	方法和说明
InvocationFuture<java.lang.Void>	ackAddFriendRequest(java.lang.String account, boolean agree) 同意/拒绝好友请求
InvocationFuture<java.lang.Void>	addFriend(AddFriendData data) 好友请求
InvocationFuture<java.lang.Void>	addToBlackList(java.lang.String account) 添加用户到黑名单
InvocationFuture<java.lang.Void>	deleteFriend(java.lang.String account) 删除好友, 默认不删除备注信息
InvocationFuture<java.lang.Void>	deleteFriend(java.lang.String account, boolean deleteAlias) 删除好友
java.util.List<java.lang.String>	getBlackList() 返回黑名单中的用户列表
java.util.List<java.lang.String>	getFriendAccounts() 获取我所有的好友帐号
Friend	getFriendByAccount(java.lang.String account) 根据用户账号获取好友关系
java.util.List<Friend>	getFriends() 获取我所有的好友关系
java.util.List<java.lang.String>	getMuteList() 获取所有不需要进行消息提醒的账号列表(静音帐号列表）
boolean	isInBlackList(java.lang.String account) 判断用户是否已被拉黑
boolean	isMyFriend(java.lang.String account) 是否为我的好友
boolean	isNeedMessageNotify(java.lang.String account) 判断用户是否需要消息提醒/静音
InvocationFuture<java.lang.Void>	removeFromBlackList(java.lang.String account) 把用户从黑名单中移除
InvocationFuture<java.util.List<java.lang.String>>	searchAccountByAlias(java.lang.String alias) 根据备注反查账号
InvocationFuture<java.util.List<Friend>>	searchFriendsByKeyword(java.lang.String keyword) 搜索与关键字匹配的所有好友
InvocationFuture<java.lang.Void>	setMessageNotify(java.lang.String account, boolean notify) 设置消息提醒/静音
InvocationFuture<java.lang.Void>	updateFriendFields(java.lang.String friendAccount, java.util.Map<FriendFieldEnum,java.lang.Object> fields) 更新好友关系

方法详细资料

addFriend

InvocationFuture<java.lang.Void> addFriend(AddFriendData data)

好友请求

参数:

data - 好友请求信息（包括对方帐号、好友请求验证类型、附言）

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

ackAddFriendRequest

InvocationFuture<java.lang.Void> ackAddFriendRequest(java.lang.String account,
                                                     boolean agree)

同意/拒绝好友请求

参数:

account - 对方帐号

agree - true表示同意，false表示拒绝

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

deleteFriend

InvocationFuture<java.lang.Void> deleteFriend(java.lang.String account)

删除好友, 默认不删除备注信息

参数:

account - 要解除好友关系的帐号

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

deleteFriend

InvocationFuture<java.lang.Void> deleteFriend(java.lang.String account,
                                              boolean deleteAlias)

删除好友

参数:

account - 要解除好友关系的帐号

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

getFriends

java.util.List<Friend> getFriends()

获取我所有的好友关系

返回:

好友关系集合

getFriendAccounts

java.util.List<java.lang.String> getFriendAccounts()

获取我所有的好友帐号

返回:

好友帐号集合

getFriendByAccount

Friend getFriendByAccount(java.lang.String account)

根据用户账号获取好友关系

参数:

account - 用户账号

返回:

该账号对应的好友关系

isMyFriend

boolean isMyFriend(java.lang.String account)

是否为我的好友

参数:

account - 对方帐号

返回:

该帐号是否为我的好友

updateFriendFields

InvocationFuture<java.lang.Void> updateFriendFields(java.lang.String friendAccount,
                                                    java.util.Map<FriendFieldEnum,java.lang.Object> fields)

更新好友关系

参数:

friendAccount - 待更新的好友账号

fields - 待更新的所有字段集合，目前支持更新备注名和扩展字段 注意:备注名最长128个字符，扩展字段需要传入Map，key为String，Value为Object，SDK负责转成Json String，最大长度256字符。

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

addToBlackList

InvocationFuture<java.lang.Void> addToBlackList(java.lang.String account)

添加用户到黑名单

参数:

account - 用户帐号

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

removeFromBlackList

InvocationFuture<java.lang.Void> removeFromBlackList(java.lang.String account)

把用户从黑名单中移除

参数:

account - 用户帐号

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

isInBlackList

boolean isInBlackList(java.lang.String account)

判断用户是否已被拉黑

参数:

account - 用戶帐号

返回:

该用户是否在黑名单列表中

getBlackList

java.util.List<java.lang.String> getBlackList()

返回黑名单中的用户列表

返回:

所有黑名单帐号集合

setMessageNotify

InvocationFuture<java.lang.Void> setMessageNotify(java.lang.String account,
                                                  boolean notify)

设置消息提醒/静音

参数:

account - 要设置消息提醒的帐号

notify - 是否提醒该用户发来的消息，false为静音（不提醒）

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

isNeedMessageNotify

boolean isNeedMessageNotify(java.lang.String account)

判断用户是否需要消息提醒/静音

参数:

account - 用户帐号

返回:

true表示需要消息提醒；false表示静音

getMuteList

java.util.List<java.lang.String> getMuteList()

获取所有不需要进行消息提醒的账号列表(静音帐号列表）

返回:

不需要进行消息提醒的帐号集合

searchFriendsByKeyword

InvocationFuture<java.util.List<Friend>> searchFriendsByKeyword(java.lang.String keyword)

搜索与关键字匹配的所有好友

返回:

好友关系集合

searchAccountByAlias

InvocationFuture<java.util.List<java.lang.String>> searchAccountByAlias(java.lang.String alias)

根据备注反查账号

参数:

alias - 备注

返回:

账号列表