FriendService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.friend;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.friend.constant.FriendFieldEnum;
import com.netease.nimlib.sdk.friend.model.AddFriendData;
import com.netease.nimlib.sdk.friend.model.Friend;
import java.util.List;
import java.util.Map;

/**
 * 好友管理/好友关系/黑名单关系/消息提醒相关操作
 */
@NIMService("好友关系服务")
public interface FriendService {

    /**
     * 好友请求
     *
     * @param data 好友请求信息（包括对方帐号、好友请求验证类型、附言）
     * @return InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> addFriend(AddFriendData data);

    /**
     * 同意/拒绝好友请求
     *
     * @param account 对方帐号
     * @param agree   true表示同意，false表示拒绝
     * @return InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> ackAddFriendRequest(String account, boolean agree);

    /**
     * 删除好友, 默认不删除备注信息
     *
     * @param account 要解除好友关系的帐号
     * @return InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> deleteFriend(String account);

    /**
     * 删除好友
     *
     * @param account 要解除好友关系的帐号
     * @param deleteAlias 是否删除备注信息
     * @return InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> deleteFriend(String account, boolean deleteAlias);

    /**
     * 获取我所有的好友关系
     *
     * @return 好友关系集合
     */
    List<Friend> getFriends();

    /**
     * 清空好友关系的同步时间戳。调用后，下次登录时将触发好友关系的全量同步。
     */
    InvocationFuture<Void> resetSyncFriendTimeStamp();

    /**
     * 获取我所有的好友帐号
     *
     * @return 好友帐号集合
     */
    List<String> getFriendAccounts();

    /**
     * 根据用户账号获取好友关系
     *
     * @param account 用户账号
     * @return 该账号对应的好友关系
     */
    Friend getFriendByAccount(String account);

    /**
     * 是否为我的好友
     *
     * @param account 对方帐号
     * @return 该帐号是否为我的好友
     */
    boolean isMyFriend(String account);

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

    /**
     * 添加用户到黑名单
     *
     * @param account 用户帐号
     * @return InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> addToBlackList(String account);

    /**
     * 把用户从黑名单中移除
     *
     * @param account 用户帐号
     * @return InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> removeFromBlackList(String account);

    /**
     * 判断用户是否已被拉黑
     *
     * @param account 用戶帐号
     * @return 该用户是否在黑名单列表中
     */
    boolean isInBlackList(String account);

    /**
     * 返回黑名单中的用户列表
     *
     * @return 所有黑名单帐号集合
     */
    List<String> getBlackList();

    /**
     * 设置消息提醒/静音
     *
     * @param account 要设置消息提醒的帐号
     * @param notify  是否提醒该用户发来的消息，false为静音（不提醒）
     * @return InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> setMessageNotify(String account, boolean notify);

    /**
     * 判断用户是否需要消息提醒/静音
     *
     * @param account 用户帐号
     * @return true表示需要消息提醒；false表示静音
     */
    boolean isNeedMessageNotify(String account);

    /**
     * 获取所有不需要进行消息提醒的账号列表(静音帐号列表）
     *
     * @return 不需要进行消息提醒的帐号集合
     */
    List<String> getMuteList();

    /**
     * 搜索与关键字匹配的所有好友
     *
     * @return 好友关系集合
     */
    InvocationFuture<List<Friend>> searchFriendsByKeyword(String keyword);

    /**
     * 根据备注反查账号
     *
     * @param alias 备注
     * @return 账号列表
     */
    InvocationFuture<List<String>> searchAccountByAlias(String alias);
}