UserService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.uinfo;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.antispam.model.AntiSpamConfig;
import com.netease.nimlib.sdk.uinfo.constant.UserInfoFieldEnum;
import com.netease.nimlib.sdk.uinfo.model.NimUserInfo;

import java.util.List;
import java.util.Map;

/**
 * 用户资料操作相关接口
 */
@NIMService("用户资料服务")
public interface UserService {

    /**
     * 从服务器获取用户资料（每次最多获取150个用户，如果量大，上层请自行分批获取）
     *
     * @param accounts 要获取的用户帐号
     * @return InvocationFuture 可以设置回调函数。在用户资料存入数据库后就会回调。
     */
    InvocationFuture<List<NimUserInfo>> fetchUserInfo(List<String> accounts);

    /**
     * 从本地数据库中批量获取用户资料（同步接口）
     *
     * @param accounts 要获取的用户帐号集合
     * @return 用户资料列表
     */
    List<NimUserInfo> getUserInfoList(List<String> accounts);

    /**
     * 从本地数据库中获取用户资料（同步接口）
     *
     * @param account 要获取的用户账号
     * @return 用户资料
     */
    NimUserInfo getUserInfo(String account);

    /**
     * 获取本地数据库中所有用户资料
     *
     * @return 所有用户资料列表
     */
    List<NimUserInfo> getAllUserInfo();

    /**
     * 更新本人用户资料
     *
     * @param fields 要更新的字段和新值, key为字段，value为对应的值
     * @return @return InvocationFuture 可以设置回调函数。
     */
    InvocationFuture<Void> updateUserInfo(Map<UserInfoFieldEnum, Object> fields);

    /**
     * 更新本人用户资料
     *
     * @param fields         要更新的字段和新值, key为字段，value为对应的值
     * @param antispamConfig 反垃圾相关配置参数
     * @return @return InvocationFuture 可以设置回调函数。
     */
    InvocationFuture<Void> updateUserInfo(Map<UserInfoFieldEnum, Object> fields,
        AntiSpamConfig antispamConfig);

    /////////////////////////////////////////////////////////////////////////////////////////////////
    /////////////// 专用接口，设置用户在线状态。SDK本身不保存在线状态，仅透传该消息到服务器 //////////////
    /////////////// @param state 在线状态。具体含义由APP自行解释 //////////////////////////////////////
    /////////////////////////////////////////////////////////////////////////////////////////////////
    InvocationFuture<Void> setUserState(int state);

    /**
     * 搜索与关键字匹配的所有用户
     *
     * @return 用户集合
     */
    InvocationFuture<List<NimUserInfo>> searchUserInfosByKeyword(String keyword);

    /**
     * 根据昵称反查账号
     *
     * @param name 昵称
     * @return 账号
     */
    InvocationFuture<List<String>> searchAccountByName(String name);
}