V2NIMTeamMemberSearchResultEx.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.team.result;

import com.netease.nimlib.sdk.v2.team.model.V2NIMTeamMember;
import com.netease.nimlib.sdk.v2.team.model.V2NIMTeamRefer;
import java.util.List;
import java.util.Map;

/**
 * 群成员搜索结果
 */
public interface V2NIMTeamMemberSearchResultEx {

    /**
     * 获取检索命中的群成员列表
     * <p>
     * 返回一个Map结构，key为群组引用(V2NIMTeamRefer)，value为该群组中
     * 匹配搜索条件的成员列表。这种结构便于按群组维度区分和展示搜索结果。
     * </p>
     * 
     * @return 以群组为key，成员列表为value的Map，不会为null
     */
    Map<V2NIMTeamRefer, List<V2NIMTeamMember>> getList();

    /**
     * 获取搜索命中的总数量
     * <p>
     * 返回本次搜索操作命中的成员总数量，包含所有群组中匹配的成员数量之和。
     * 该数量为实际匹配的成员数量，不受分页限制影响。
     * </p>
     * <p>
     * 使用场景：
     * <ul>
     *   <li>在UI中显示搜索结果总数，如"找到123个成员"</li>
     *   <li>判断是否有搜索结果</li>
     *   <li>计算分页相关信息</li>
     * </ul>
     * </p>
     *
     * @return 命中的成员总数量，大于等于0
     */
    int getCount();

    /**
     * 获取下次搜索的偏移量标记
     * <p>
     * 用于分页查询的连续性标记。客户端可以使用该token进行下一页的搜索请求。
     * </p>
     * <p>
     * 取值规则：
     * <ul>
     *   <li>当finished为false时，nextToken包含下次查询的起始位置信息</li>
     *   <li>当finished为true时，nextToken为空字符串""，表示已查询完毕</li>
     *   <li>首次查询时应传入空字符串""</li>
     * </ul>
     * </p>
     * 
     * @return 下次搜索的偏移量标记，不会为null
     */
    String getNextToken();

    /**
     * 判断查询是否已完成
     * <p>
     * 标识本次搜索是否已经返回了所有匹配的结果。
     * </p>
     * <p>
     * 返回值含义：
     * <ul>
     *   <li>true: 表示已查询完所有匹配结果，无需继续分页查询</li>
     *   <li>false: 表示还有更多结果，可以使用nextToken继续查询</li>
     * </ul>
     * </p>
     * <p>
     * 注意事项：
     * <ul>
     *   <li>当finished为true时，nextToken会被设置为空字符串""</li>
     *   <li>即使当前页没有返回结果，finished也可能为false（表示后续页面可能有结果）</li>
     * </ul>
     * </p>
     * 
     * @return true表示查询完成，false表示还有更多结果
     */
    boolean isFinished();
}