V2NIMFriendService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.friend;

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.friend.option.V2NIMFriendAddApplicationQueryOption;
import com.netease.nimlib.sdk.v2.friend.option.V2NIMFriendClearAddApplicationOption;
import com.netease.nimlib.sdk.v2.friend.option.V2NIMFriendSearchOption;
import com.netease.nimlib.sdk.v2.friend.param.V2NIMFriendAddParams;
import com.netease.nimlib.sdk.v2.friend.param.V2NIMFriendDeleteParams;
import com.netease.nimlib.sdk.v2.friend.param.V2NIMFriendSetParams;
import com.netease.nimlib.sdk.v2.friend.result.V2NIMFriendAddApplicationResult;
import java.util.List;
import java.util.Map;

public interface V2NIMFriendService {
    /**
     *  添加好友
     *      该方法调用后， 系统会发送给对端一条系统通知， 通知类型：
     *          FRIEND_ADD(5), //加好友，attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}}
     *      该接口调用后
     *          addMode：
     *              ADD：本端， 对端SDK会抛出： onFriendAdded
     *              APPLAY:  对端SDK会抛出：onFriendAddApplicaiton
     *
     *  @param accountId 被添加为好友的账号ID
     *  @param params 添加好友参数
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void addFriend(String accountId, V2NIMFriendAddParams params, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);


    /**
     *  删除好友
     *      该方法调用后， 系统会发送给对端一条系统通知， 通知类型：
     *          FRIEND_DELETE(6), //删除好友，
     *      当前V1只实现了双向删除， 保持功能不变，待客户需求驱动调整
     *  该接口调用后
     *      本端， 对端SDK会抛出： onFriendDeleted
     *
     *  @param accountId 被删除好友的账号ID
     *  @param params 删除好友参数
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void deleteFriend(String accountId, V2NIMFriendDeleteParams params, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);


    /**
     *  接受好友申请
     *      该方法调用后， 该方法调用后， 系统会发送给对端一条系统通知， 通知类型：
     *          FRIEND_ADD(5), //加好友，attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}}
     *  该接口调用后
     *      本端， 对端SDK会抛出： onFriendAdded
     *
     *  @param application 申请添加好友的相关信息
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    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会抛出： onFriendAddRejected
     *
     *  @param application 申请添加好友的相关信息
     *  @param postscript 拒绝申请的附言
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void rejectAddApplication(V2NIMFriendAddApplication application, String postscript, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);


    /**
     *  设置好友信息
     *  该接口调用后
     *      本端SDK会抛出： onFriendsInfoChanged
     *
     *  @param accountId 好友的账号ID
     *  @param params 设置好友信息参数
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void setFriendInfo(String accountId, V2NIMFriendSetParams params, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);


    /**
     *  获取好友列表
     *      本地查询
     *      登录后开始同步好友信息， 建议同步完成后，拉取一次
     *
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void getFriendList(V2NIMSuccessCallback<List<V2NIMFriend>> success, V2NIMFailureCallback failure);


    /**
     * 根据账号ID获取好友信息
     * 只返回ID存在的好友信息
     * 返回序与输入序一致
     *
     * @param accountIds 获取好友信息的账号ID列表
     * @param success    请求成功的回调
     * @param failure    请求失败的回调
     */
    void getFriendByIds(List<String> accountIds, V2NIMSuccessCallback<List<V2NIMFriend>> success, V2NIMFailureCallback failure);


    /**
     *  根据账号ID检查好友状态
     *
     *  @param accountIds 检查好友状态的账号ID列表
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void checkFriend(List<String> accountIds, V2NIMSuccessCallback<Map<String, Boolean>> success, V2NIMFailureCallback failure);


    /**
     *  获取申请添加好友信息列表
     *      FRIEND_ADD(5), //加好友，attach: {"vt":verifyType,"serverex":{"0":"int, 是否下发serverex信息,0,不下发,1,下发","1":"string, serverex信息,只有"0"为下发才有"}}
     *      只查询verifyType等于3数据
     *      从新到老查询
     *
     *  @param option 查询申请添加好友相关信息参数
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void getAddApplicationList(V2NIMFriendAddApplicationQueryOption option, V2NIMSuccessCallback<V2NIMFriendAddApplicationResult> success, V2NIMFailureCallback failure);

    /**
     *  获取好友申请未读数量
     *  统计所有状态为未处理，且未读的数量
     */
    void getAddApplicationUnreadCount(V2NIMSuccessCallback<Integer> success, V2NIMFailureCallback failure);

    /**
     *  设置好友申请已读
     *      调用该方法，历史数据未读数据均标记为已读
     */
    void setAddApplicationRead(V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 设置好友申请已读
     * @param application
     * @param success
     * @param failure
     */
    void setAddApplicationReadEx(V2NIMFriendAddApplication application,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  根据关键字搜索好友信息
     *
     *  @param friendSearchOption 好友搜索相关参数
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void searchFriendByOption(V2NIMFriendSearchOption friendSearchOption, V2NIMSuccessCallback<List<V2NIMFriend>> success, V2NIMFailureCallback failure);

    /**
     * 清空所有好友申请
     * @param success
     * @param failure
     */
    void clearAllAddApplication(V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  清空好友申请
     * @param option
     * @param success
     * @param failure
     */
    void clearAllAddApplicationEx(V2NIMFriendClearAddApplicationOption option, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  删除好友申请
     * @param application
     * @param success
     * @param failure
     */
    void deleteAddApplication(V2NIMFriendAddApplication application, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  添加好友监听器
     *
     *  @param listener 好友信息监听回调
     */
    void addFriendListener(V2NIMFriendListener listener);


    /**
     *  移除好友信息监听器
     *
     *  @param listener 移除的监听回调
     */
    void removeFriendListener(V2NIMFriendListener listener);
}