NIMSDK-AOS  9.16.0
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.friend.FriendService接口 参考

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

Public 成员函数

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

详细描述

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

在文件 FriendService.java16 行定义.

成员函数说明

◆ ackAddFriendRequest()

InvocationFuture<Void> com.netease.nimlib.sdk.friend.FriendService.ackAddFriendRequest ( String  account,
boolean  agree 
)

同意/拒绝好友请求

参数
account对方帐号
agreetrue表示同意,false表示拒绝
返回
InvocationFuture 可以设置回调函数。消息发送完成后才会调用,如果出错,会有具体的错误代码。

◆ addFriend()

InvocationFuture<Void> com.netease.nimlib.sdk.friend.FriendService.addFriend ( AddFriendData  data)

好友请求

参数
data好友请求信息(包括对方帐号、好友请求验证类型、附言)
返回
InvocationFuture 可以设置回调函数。消息发送完成后才会调用,如果出错,会有具体的错误代码。

◆ addToBlackList()

InvocationFuture<Void> com.netease.nimlib.sdk.friend.FriendService.addToBlackList ( String  account)

添加用户到黑名单

参数
account用户帐号
返回
InvocationFuture 可以设置回调函数。消息发送完成后才会调用,如果出错,会有具体的错误代码。

◆ deleteFriend() [1/2]

InvocationFuture<Void> com.netease.nimlib.sdk.friend.FriendService.deleteFriend ( String  account)

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

参数
account要解除好友关系的帐号
返回
InvocationFuture 可以设置回调函数。消息发送完成后才会调用,如果出错,会有具体的错误代码。

◆ deleteFriend() [2/2]

InvocationFuture<Void> com.netease.nimlib.sdk.friend.FriendService.deleteFriend ( String  account,
boolean  deleteAlias 
)

删除好友

参数
account要解除好友关系的帐号
返回
InvocationFuture 可以设置回调函数。消息发送完成后才会调用,如果出错,会有具体的错误代码。

◆ getBlackList()

List<String> com.netease.nimlib.sdk.friend.FriendService.getBlackList ( )

返回黑名单中的用户列表

返回
所有黑名单帐号集合

◆ getFriendAccounts()

List<String> com.netease.nimlib.sdk.friend.FriendService.getFriendAccounts ( )

获取我所有的好友帐号

返回
好友帐号集合

◆ getFriendByAccount()

Friend com.netease.nimlib.sdk.friend.FriendService.getFriendByAccount ( String  account)

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

参数
account用户账号
返回
该账号对应的好友关系

◆ getFriends()

List<Friend> com.netease.nimlib.sdk.friend.FriendService.getFriends ( )

获取我所有的好友关系

返回
好友关系集合

◆ getMuteList()

List<String> com.netease.nimlib.sdk.friend.FriendService.getMuteList ( )

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

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

◆ isInBlackList()

boolean com.netease.nimlib.sdk.friend.FriendService.isInBlackList ( String  account)

判断用户是否已被拉黑

参数
account用戶帐号
返回
该用户是否在黑名单列表中

◆ isMyFriend()

boolean com.netease.nimlib.sdk.friend.FriendService.isMyFriend ( String  account)

是否为我的好友

参数
account对方帐号
返回
该帐号是否为我的好友

◆ isNeedMessageNotify()

boolean com.netease.nimlib.sdk.friend.FriendService.isNeedMessageNotify ( String  account)

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

参数
account用户帐号
返回
true表示需要消息提醒;false表示静音

◆ removeFromBlackList()

InvocationFuture<Void> com.netease.nimlib.sdk.friend.FriendService.removeFromBlackList ( String  account)

把用户从黑名单中移除

参数
account用户帐号
返回
InvocationFuture 可以设置回调函数。消息发送完成后才会调用,如果出错,会有具体的错误代码。

◆ searchAccountByAlias()

InvocationFuture<List<String> > com.netease.nimlib.sdk.friend.FriendService.searchAccountByAlias ( String  alias)

根据备注反查账号

参数
alias备注
返回
账号列表

◆ searchFriendsByKeyword()

InvocationFuture<List<Friend> > com.netease.nimlib.sdk.friend.FriendService.searchFriendsByKeyword ( String  keyword)

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

返回
好友关系集合

◆ setMessageNotify()

InvocationFuture<Void> com.netease.nimlib.sdk.friend.FriendService.setMessageNotify ( String  account,
boolean  notify 
)

设置消息提醒/静音

参数
account要设置消息提醒的帐号
notify是否提醒该用户发来的消息,false为静音(不提醒)
返回
InvocationFuture 可以设置回调函数。消息发送完成后才会调用,如果出错,会有具体的错误代码。

◆ updateFriendFields()

InvocationFuture<Void> com.netease.nimlib.sdk.friend.FriendService.updateFriendFields ( String  friendAccount,
Map< FriendFieldEnum, Object >  fields 
)

更新好友关系

参数
friendAccount待更新的好友账号
fields待更新的所有字段集合,目前支持更新备注名和扩展字段 注意:备注名最长128个字符,扩展字段需要传入Map,key为String,Value为Object,SDK负责转成Json String,最大长度256字符。
返回
InvocationFuture 可以设置回调函数。消息发送完成后才会调用,如果出错,会有具体的错误代码。

该接口的文档由以下文件生成: