V2NIMUserService.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.V2NIMSyncResult;
import com.netease.nimlib.sdk.v2.user.option.V2NIMUserSearchOption;
import com.netease.nimlib.sdk.v2.user.params.V2NIMUserUpdateParams;
import java.util.List;
import java.util.Map;

public interface V2NIMUserService {

    /**
     *  根据用户账号获取用户资料
     *
     *
     *  @param accountId 需要获取用户资料的账号
     *  @return 用户资料
     *
     *  @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     */
    V2NIMSyncResult<V2NIMUser> getUserInfo(String accountId);

    /**
     *  根据用户账号列表获取用户资料
     *  单次最大值150
     *  只返回ID存在的用户， 错误ID不返回
     *  返回顺序以传入序为准（可以不做强制校验）
     *  先查询本地缓存，本地缺失或不足，再查询云端
     *
     *  @param accountIds 需要获取用户资料的账号列表
     *          List为空， 或者size==0， 返回参数错误
     *          单次最大150
     *  @param success 获取列表成功的回调
     *  @param failure 获取列表失败的回调
     */
    void getUserList(List<String> accountIds, V2NIMSuccessCallback<List<V2NIMUser>> success, V2NIMFailureCallback failure);

    /**
     *  根据用户账号列表获取用户资料
     *  单次最大值150
     *  只返回ID存在的用户， 错误ID不返回
     *  返回顺序以传入序为准
     *  只查询本地
     *
     *  @param accountIds 需要获取用户资料的账号列表
     *          List为空， 或者size==0， 返回参数错误
     *          单次最大150
     *  @return 用户资料列表
     *
     *  @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     */
    V2NIMSyncResult<List<V2NIMUser>> getUserList(List<String> accountIds);

    /**
     *  根据用户账号列表从服务器获取用户资料
     *  单次最大值150
     *  只返回ID存在的用户， 错误ID不返回
     *  返回顺序以传入序为准（可以不做强制校验）
     *  直接查询云端
     *  如果是协议错， 则整体返回错， 否则返回部分成功
     *  如果查询数据后，本地成员数据有更新， 则触发用户信息更新回调
     *
     *  @param accountIds 需要获取用户资料的账号列表
     *          List为空， 或者size==0， 返回参数错误
     *          单次最大150
     *  @param success 获取列表成功的回调
     *  @param failure 获取列表失败的回调
     */
    void getUserListFromCloud(List<String> accountIds, V2NIMSuccessCallback<List<V2NIMUser>> success, V2NIMFailureCallback failure);

    /**
     *  更新自己的用户资料
     *  调用该Api后， SDK会抛出： onUserProfileChanged
     *
     *  @param updateParams 更新自己的用户资料参数
     *  @param success 更新用户资料成功的回调
     *  @param failure 更新用户资料失败的回调
     */
    void updateSelfUserProfile(V2NIMUserUpdateParams updateParams, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  添加用户到黑名单中
     *
     *  @param accountId 需要添加进黑名单的用户ID
     *  @param success 添加成功的回调
     *  @param failure 添加失败的回调
     */
    void addUserToBlockList(String accountId, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  从黑名单中移除用户
     *
     *  @param accountId 需要移除黑名单的用户ID
     *  @param success 移除成功的回调
     *  @param failure 移除失败的回调
     */
    void removeUserFromBlockList(String accountId, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     *  获取黑名单列表
     *
     *  @param success 获取列表成功的回调
     *  @param failure 获取列表失败的回调
     */
    void getBlockList(V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);

    /**
     * 查看是否在黑名单
     * @param accountIds 检查黑名单状态的账号ID列表
     * @param success 获取成功的回调，在黑名单列表的check返回为true，其它的账号不存在，不在黑名单， 账号格式错误均统一返回false
     * @param failure 获取失败的回调
     */
    void checkBlock(List<String> accountIds, V2NIMSuccessCallback<Map<String, Boolean>> success, V2NIMFailureCallback failure);

    /**
     *  根据关键字搜索用户信息
     *
     *  @param userSearchOption 用户搜索相关参数
     *  @param success 请求成功的回调
     *  @param failure 请求失败的回调
     */
    void searchUserByOption(V2NIMUserSearchOption userSearchOption, V2NIMSuccessCallback<List<V2NIMUser>> success, V2NIMFailureCallback failure);

    /**
     *  添加用户资料监听器
     *
     *  @param listener 用户资料监听回调
     */
    void addUserListener(V2NIMUserListener listener);

    /**
     *  移除用户资料监听器
     *
     *  @param listener 移除的监听回调
     */
    void removeUserListener(V2NIMUserListener listener);
}