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

Public 成员函数

void addFriend (String accountId, V2NIMFriendAddParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 添加好友 该方法调用后, 系统会发送给对端一条系统通知, 通知类型: FRIEND_ADD(5), //加好友,attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}} 该接口调用后 addMode: ADD:本端, 对端SDK会抛出: onFriendAdded APPLAY: 对端SDK会抛出:onFriendAddApplicaiton 更多...
 
void deleteFriend (String accountId, V2NIMFriendDeleteParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 删除好友 该方法调用后, 系统会发送给对端一条系统通知, 通知类型: FRIEND_DELETE(6), //删除好友, 当前V1只实现了双向删除, 保持功能不变,待客户需求驱动调整 该接口调用后 本端, 对端SDK会抛出: onFriendDeleted 更多...
 
void acceptAddApplication (V2NIMFriendAddApplication application, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 接受好友申请 该方法调用后, 该方法调用后, 系统会发送给对端一条系统通知, 通知类型: FRIEND_ADD(5), //加好友,attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}} 该接口调用后 本端, 对端SDK会抛出: onFriendAdded 更多...
 
void rejectAddApplication (V2NIMFriendAddApplication application, String postscript, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 拒绝添加好友申请 该方法调用后, 该方法调用后, 系统会发送给对端一条系统通知, 通知类型: FRIEND_ADD(5), //加好友,attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}} 该接口调用后 对端SDK会抛出: onFriendAddRejected 更多...
 
void setFriendInfo (String accountId, V2NIMFriendSetParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 设置好友信息 该接口调用后 本端SDK会抛出: onFriendsInfoChanged 更多...
 
void getFriendList (V2NIMSuccessCallback< List< V2NIMFriend >> success, V2NIMFailureCallback failure)
 获取好友列表 本地查询 登录后开始同步好友信息, 建议同步完成后,拉取一次 更多...
 
void getFriendByIds (List< String > accountIds, V2NIMSuccessCallback< List< V2NIMFriend >> success, V2NIMFailureCallback failure)
 根据账号ID获取好友信息 只返回ID存在的好友信息 返回序与输入序一致 更多...
 
void checkFriend (List< String > accountIds, V2NIMSuccessCallback< Map< String, Boolean >> success, V2NIMFailureCallback failure)
 根据账号ID检查好友状态 更多...
 
void getAddApplicationList (V2NIMFriendAddApplicationQueryOption option, V2NIMSuccessCallback< V2NIMFriendAddApplicationResult > success, V2NIMFailureCallback failure)
 获取申请添加好友信息列表 FRIEND_ADD(5), //加好友,attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}} 只查询verifyType等于3数据 从新到老查询 更多...
 
void getAddApplicationUnreadCount (V2NIMSuccessCallback< Integer > success, V2NIMFailureCallback failure)
 获取好友申请未读数量 统计所有状态为未处理,且未读的数量 更多...
 
void setAddApplicationRead (V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 设置好友申请已读 调用该方法,历史数据未读数据均标记为已读 更多...
 
void setAddApplicationReadEx (V2NIMFriendAddApplication application, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 设置好友申请已读 更多...
 
void searchFriendByOption (V2NIMFriendSearchOption friendSearchOption, V2NIMSuccessCallback< List< V2NIMFriend >> success, V2NIMFailureCallback failure)
 根据关键字搜索好友信息 更多...
 
void clearAllAddApplication (V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 清空所有好友申请 更多...
 
void clearAllAddApplicationEx (V2NIMFriendClearAddApplicationOption option, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 清空好友申请 更多...
 
void deleteAddApplication (V2NIMFriendAddApplication application, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 删除好友申请 更多...
 
void addFriendListener (V2NIMFriendListener listener)
 添加好友监听器 更多...
 
void removeFriendListener (V2NIMFriendListener listener)
 移除好友信息监听器 更多...
 

详细描述

在文件 V2NIMFriendService.java15 行定义.

成员函数说明

void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.acceptAddApplication ( V2NIMFriendAddApplication  application,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

接受好友申请 该方法调用后, 该方法调用后, 系统会发送给对端一条系统通知, 通知类型: FRIEND_ADD(5), //加好友,attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}} 该接口调用后 本端, 对端SDK会抛出: onFriendAdded

参数
application申请添加好友的相关信息
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.addFriend ( String  accountId,
V2NIMFriendAddParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

添加好友 该方法调用后, 系统会发送给对端一条系统通知, 通知类型: FRIEND_ADD(5), //加好友,attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}} 该接口调用后 addMode: ADD:本端, 对端SDK会抛出: onFriendAdded APPLAY: 对端SDK会抛出:onFriendAddApplicaiton

参数
accountId被添加为好友的账号ID
params添加好友参数
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.addFriendListener ( V2NIMFriendListener  listener)

添加好友监听器

参数
listener好友信息监听回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.checkFriend ( List< String >  accountIds,
V2NIMSuccessCallback< Map< String, Boolean >>  success,
V2NIMFailureCallback  failure 
)

根据账号ID检查好友状态

参数
accountIds检查好友状态的账号ID列表
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.clearAllAddApplication ( V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

清空所有好友申请

参数
success
failure
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.clearAllAddApplicationEx ( V2NIMFriendClearAddApplicationOption  option,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

清空好友申请

参数
option
success
failure
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.deleteAddApplication ( V2NIMFriendAddApplication  application,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

删除好友申请

参数
application
success
failure
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.deleteFriend ( String  accountId,
V2NIMFriendDeleteParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

删除好友 该方法调用后, 系统会发送给对端一条系统通知, 通知类型: FRIEND_DELETE(6), //删除好友, 当前V1只实现了双向删除, 保持功能不变,待客户需求驱动调整 该接口调用后 本端, 对端SDK会抛出: onFriendDeleted

参数
accountId被删除好友的账号ID
params删除好友参数
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.getAddApplicationList ( V2NIMFriendAddApplicationQueryOption  option,
V2NIMSuccessCallback< V2NIMFriendAddApplicationResult success,
V2NIMFailureCallback  failure 
)

获取申请添加好友信息列表 FRIEND_ADD(5), //加好友,attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}} 只查询verifyType等于3数据 从新到老查询

参数
option查询申请添加好友相关信息参数
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.getAddApplicationUnreadCount ( V2NIMSuccessCallback< Integer >  success,
V2NIMFailureCallback  failure 
)

获取好友申请未读数量 统计所有状态为未处理,且未读的数量

void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.getFriendByIds ( List< String >  accountIds,
V2NIMSuccessCallback< List< V2NIMFriend >>  success,
V2NIMFailureCallback  failure 
)

根据账号ID获取好友信息 只返回ID存在的好友信息 返回序与输入序一致

参数
accountIds获取好友信息的账号ID列表
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.getFriendList ( V2NIMSuccessCallback< List< V2NIMFriend >>  success,
V2NIMFailureCallback  failure 
)

获取好友列表 本地查询 登录后开始同步好友信息, 建议同步完成后,拉取一次

参数
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.rejectAddApplication ( V2NIMFriendAddApplication  application,
String  postscript,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

拒绝添加好友申请 该方法调用后, 该方法调用后, 系统会发送给对端一条系统通知, 通知类型: FRIEND_ADD(5), //加好友,attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}} 该接口调用后 对端SDK会抛出: onFriendAddRejected

参数
application申请添加好友的相关信息
postscript拒绝申请的附言
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.removeFriendListener ( V2NIMFriendListener  listener)

移除好友信息监听器

参数
listener移除的监听回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.searchFriendByOption ( V2NIMFriendSearchOption  friendSearchOption,
V2NIMSuccessCallback< List< V2NIMFriend >>  success,
V2NIMFailureCallback  failure 
)

根据关键字搜索好友信息

参数
friendSearchOption好友搜索相关参数
success请求成功的回调
failure请求失败的回调
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.setAddApplicationRead ( V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

设置好友申请已读 调用该方法,历史数据未读数据均标记为已读

void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.setAddApplicationReadEx ( V2NIMFriendAddApplication  application,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

设置好友申请已读

参数
application
success
failure
void com.netease.nimlib.sdk.v2.friend.V2NIMFriendService.setFriendInfo ( String  accountId,
V2NIMFriendSetParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

设置好友信息 该接口调用后 本端SDK会抛出: onFriendsInfoChanged

参数
accountId好友的账号ID
params设置好友信息参数
success请求成功的回调
failure请求失败的回调

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