V2NIMTeamService.java

浏览该文件的文档.

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

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.common.V2NIMAntispamConfig;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamChatBannedMode;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamMemberRole;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamType;
import com.netease.nimlib.sdk.v2.team.model.V2NIMTeam;
import com.netease.nimlib.sdk.v2.team.model.V2NIMTeamJoinActionInfo;
import com.netease.nimlib.sdk.v2.team.model.V2NIMTeamMember;
import com.netease.nimlib.sdk.v2.team.model.V2NIMTeamRefer;
import com.netease.nimlib.sdk.v2.team.option.V2NIMTeamClearJoinActionInfoOption;
import com.netease.nimlib.sdk.v2.team.option.V2NIMTeamJoinActionInfoQueryOption;
import com.netease.nimlib.sdk.v2.team.option.V2NIMTeamMemberQueryOption;
import com.netease.nimlib.sdk.v2.team.option.V2NIMTeamMemberSearchOption;
import com.netease.nimlib.sdk.v2.team.params.V2NIMCreateTeamParams;
import com.netease.nimlib.sdk.v2.team.params.V2NIMSearchTeamMemberParams;
import com.netease.nimlib.sdk.v2.team.params.V2NIMTeamInviteParams;
import com.netease.nimlib.sdk.v2.team.params.V2NIMTeamSearchParams;
import com.netease.nimlib.sdk.v2.team.params.V2NIMUpdateMemberNickParams;
import com.netease.nimlib.sdk.v2.team.params.V2NIMUpdateSelfMemberInfoParams;
import com.netease.nimlib.sdk.v2.team.params.V2NIMUpdateTeamInfoParams;
import com.netease.nimlib.sdk.v2.team.result.V2NIMCreateTeamResult;
import com.netease.nimlib.sdk.v2.team.result.V2NIMTeamJoinActionInfoResult;
import com.netease.nimlib.sdk.v2.team.result.V2NIMTeamMemberListResult;
import com.netease.nimlib.sdk.v2.team.result.V2NIMTeamMemberSearchResult;

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

/**
 * V2群组服务
 */
public interface V2NIMTeamService {

    /**
     * 创建群组
     * @param createTeamParams 创建群组参数
     * @param inviteeAccountIds 群组创建时，同时被邀请加入群的成员列表
     * @param postscript 邀请入群的附言
     * @param antispamConfig 易盾反垃圾配置，如果不审核，该配置不需要配置；如果开启了安全通，默认采用安全通，该配置不需要配置；如果需要审核，且直接对接易盾，则配置该配置
     * @param success 成功回调
     * @param failure 失败回调
     */
    void createTeam(V2NIMCreateTeamParams createTeamParams, List<String> inviteeAccountIds, String postscript, V2NIMAntispamConfig antispamConfig,V2NIMSuccessCallback<V2NIMCreateTeamResult> success, V2NIMFailureCallback failure);

    /**
     * 修改群组信息
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param updateTeamInfoParams 修改群组信息参数
     * @param antispamConfig  易盾反垃圾配置，如果不审核，该配置不需要配置；如果开启了安全通，默认采用安全通，该配置不需要配置；如果需要审核，且直接对接易盾，则配置该配置
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateTeamInfo(String teamId, V2NIMTeamType teamType, V2NIMUpdateTeamInfoParams updateTeamInfoParams, V2NIMAntispamConfig antispamConfig,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 离开群组
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param success 成功回调
     * @param failure 失败回调
     */
    void leaveTeam(String teamId, V2NIMTeamType teamType,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 获取群组信息
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getTeamInfo(String teamId, V2NIMTeamType teamType,V2NIMSuccessCallback<V2NIMTeam> success, V2NIMFailureCallback failure);

    /**
     * 获取群组信息
     * @param teamId 群组id
     * @param teamType 群组类型
     * @return 群组信息
     *
     * @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     */
    V2NIMSyncResult<V2NIMTeam> getTeamInfo(String teamId, V2NIMTeamType teamType);

    /**
     * 从云端获取群组信息
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getTeamInfoFromCloud(String teamId, V2NIMTeamType teamType,V2NIMSuccessCallback<V2NIMTeam> success, V2NIMFailureCallback failure);

    /**
     * 根据群组ID获取群组信息
     * @param teamIds 群组id列表
     * @param teamType 群组类型
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getTeamInfoByIds(List<String> teamIds, V2NIMTeamType teamType,V2NIMSuccessCallback<List<V2NIMTeam>> success, V2NIMFailureCallback failure);

    /**
     * 根据群组ID获取群组信息
     * @param teamIds 群组id列表
     * @param teamType 群组类型
     * @return 群组信息
     *
     * @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     */
    V2NIMSyncResult<List<V2NIMTeam>> getTeamInfoByIds(List<String> teamIds, V2NIMTeamType teamType);

    /**
     * 解散群组
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param success 成功回调
     * @param failure 失败回调
     */
    void dismissTeam(String teamId, V2NIMTeamType teamType,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 邀请成员加入群组
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param invitorAccountIds 邀请进群的成员列表
     * @param postscript 邀请入群的附言
     * @param success 成功回调，返回邀请失败的列表，如果全部成功，返回empty list
     * @param failure 失败回调
     */
    void inviteMember(String teamId, V2NIMTeamType teamType, List<String> invitorAccountIds, String postscript,V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);

    /**
     * 邀请成员加入群组
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param inviteeParams 被邀请加入群的参数
     * @param success 成功回调，返回邀请失败的列表，如果全部成功，返回empty list
     * @param failure 失败回调
     */
    void inviteMemberEx(String teamId, V2NIMTeamType teamType, V2NIMTeamInviteParams inviteeParams,V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);

    /**
     * 同意邀请入群
     * @param invitationInfo 收到的邀请入群信息
     * @param success 成功回调
     * @param failure 失败回调
     */
    void acceptInvitation(V2NIMTeamJoinActionInfo invitationInfo,V2NIMSuccessCallback<V2NIMTeam> success, V2NIMFailureCallback failure);

    /**
     * 拒绝邀请入群
     * @param invitationInfo 收到的邀请入群信息
     * @param postscript 拒绝入群的附言
     * @param success 成功回调
     * @param failure 失败回调
     */
    void rejectInvitation(V2NIMTeamJoinActionInfo invitationInfo, String postscript,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 踢出群组成员
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param memberAccountIds 被踢出群组的成员列表
     * @param success 成功回调
     * @param failure 失败回调
     */
    void kickMember(String teamId, V2NIMTeamType teamType, List<String> memberAccountIds, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 申请加入群组
     * @param teamId
     * @param teamType
     * @param postscript
     * @param success
     * @param failure
     */
    void applyJoinTeam(String teamId, V2NIMTeamType teamType, String postscript,V2NIMSuccessCallback<V2NIMTeam> success, V2NIMFailureCallback failure);

    /**
     * 接受入群加入请求
     * @param applicationInfo 加入申请的相关信息
     * @param success 成功回调
     * @param failure 失败回调
     */
    void acceptJoinApplication(V2NIMTeamJoinActionInfo applicationInfo,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 拒绝入群加入请求
     * @param applicationInfo 加入申请的相关信息
     * @param postscript 拒绝申请加入的附言
     * @param success 成功回调
     * @param failure 失败回调
     */
    void rejectJoinApplication(V2NIMTeamJoinActionInfo applicationInfo, String postscript,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 更新群组成员角色
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param memberAccountIds 群成员账号id列表
     * @param memberRole 群成员角色
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateTeamMemberRole(String teamId, V2NIMTeamType teamType, List<String> memberAccountIds, V2NIMTeamMemberRole memberRole,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 转移群组群主
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param accountId 新群主的账号id
     * @param leave 转让群主后，是否同时退出该群
     * @param success
     * @param failure
     */
    void transferTeamOwner(String teamId, V2NIMTeamType teamType, String accountId, boolean leave,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 修改自己的群成员信息
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param memberInfoParams 被修改的字段
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateSelfTeamMemberInfo(String teamId, V2NIMTeamType teamType, V2NIMUpdateSelfMemberInfoParams memberInfoParams,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 修改群成员昵称
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param accountId 被修改成员的账号
     * @param teamNick 被修改成员新的昵称
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateTeamMemberNick(String teamId, V2NIMTeamType teamType, String accountId, String teamNick,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);


    /**
     * 修改群成员昵称Ex
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param nickParams 被修改成员的账号和新的昵称
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateTeamMemberNickEx(String teamId, V2NIMTeamType teamType, V2NIMUpdateMemberNickParams nickParams, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 设置群组禁言模式
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param chatBannedMode 群组禁言模式
     * @param success 成功回调
     * @param failure 失败回调
     */
    void setTeamChatBannedMode(String teamId, V2NIMTeamType teamType, V2NIMTeamChatBannedMode chatBannedMode,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 设置群组成员聊天禁言状态
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param accountId 被修改成员的账号
     * @param chatBanned 群组中聊天是否被禁言,true:被禁言,false:未禁言
     * @param success
     * @param failure
     */
    void setTeamMemberChatBannedStatus(String teamId, V2NIMTeamType teamType, String accountId, boolean chatBanned,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 获取当前已经加入的群组列表
     * @param teamTypes 群组类型列表，如果为null，或者列表为empty， 表示查询所有所有群类型,否则按输入群类型进行查询
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getJoinedTeamList(List<V2NIMTeamType> teamTypes, V2NIMSuccessCallback<List<V2NIMTeam>> success, V2NIMFailureCallback failure);

    /**
     * 同步获取当前已经加入的群组列表
     *
     * 返回群组按群组创建时间升序排序
     * 需要判断群组是否有效且自己在群中
     * 只查本地
     * @param teamTypes 群组类型列表，如果为null，或者列表为empty， 表示查询所有所有群类型,否则按输入群类型进行查询
     * @return 群组列表
     *
     * @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     */
    V2NIMSyncResult<List<V2NIMTeam>> getJoinedTeamList(List<V2NIMTeamType> teamTypes);

    /**
     * 同步获取当前自己的群组列表
     *
     * 返回群组按群组创建时间升序排序
     * 需要判断群组是否有效且自己在群中
     * 只查本地
     * @param teamTypes 群组类型列表，如果为null，或者列表为empty， 表示查询所有所有群类型,否则按输入群类型进行查询
     * @return 群组列表
     */
    V2NIMSyncResult<List<V2NIMTeam>> getOwnerTeamList(List<V2NIMTeamType> teamTypes);

    /**
     * 获取当前自己为管理员的群组列表（包括自己是群主的群）
     *
     * 返回群组按群组创建时间升序排序
     * 需要判断群组是否有效且自己在群中
     * 只查本地
     *
     * @param teamTypes 群组类型列表，如果为null，或者列表为empty， 表示查询所有所有群类型,否则按输入群类型进行查询
     *
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getManagerTeamList(List<V2NIMTeamType> teamTypes, V2NIMSuccessCallback<List<V2NIMTeam>> success, V2NIMFailureCallback failure);

    /**
     * 获取当前已经加入的群组列表数量
     * @param teamTypes 群组类型列表，如果为null，或者列表为empty， 表示查询所有所有群类型,否则按输入群类型进行查询
     * @return 群组数量
     */
    int getJoinedTeamCount(List<V2NIMTeamType> teamTypes);

    /**
     * 获取群组成员列表
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param queryOption 查询选项
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getTeamMemberList(String teamId, V2NIMTeamType teamType, V2NIMTeamMemberQueryOption queryOption, V2NIMSuccessCallback<V2NIMTeamMemberListResult> success, V2NIMFailureCallback failure);

    /**
     * 根据账号ID列表获取群组成员列表
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param accountIds 账号id列表
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getTeamMemberListByIds(String teamId, V2NIMTeamType teamType, List<String> accountIds, V2NIMSuccessCallback<List<V2NIMTeamMember>> success, V2NIMFailureCallback failure);

    /**
     * 根据账号ID列表获取群组成员列表
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param accountIds 账号id列表
     * @return 群组成员列表
     *
     * @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     */
    V2NIMSyncResult<List<V2NIMTeamMember>> getTeamMemberListByIds(String teamId, V2NIMTeamType teamType, List<String> accountIds);

    /**
     * 获取自己所有加入的群的群成员信息
     * @param teamTypes 如果为null，或者列表为empty， 表示查询所有所有群类型，否则按输入群类型进行查询
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getJoinedTeamMembers(List<V2NIMTeamType> teamTypes, V2NIMSuccessCallback<List<V2NIMTeamMember>> success, V2NIMFailureCallback failure);


    /**
     * 根据账号ID列表获取群组成员邀请人
     * @param teamId 群组id
     * @param teamType 群组类型
     * @param accountIds 账号id列表
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getTeamMemberInvitor(String teamId, V2NIMTeamType teamType, List<String> accountIds, V2NIMSuccessCallback<Map<String, String>> success, V2NIMFailureCallback failure);

    /**
     * 获取群加入相关信息
     * @param option
     * @param success
     * @param failure
     */
    void getTeamJoinActionInfoList(V2NIMTeamJoinActionInfoQueryOption option, V2NIMSuccessCallback<V2NIMTeamJoinActionInfoResult> success, V2NIMFailureCallback failure);

    /**
     * 根据关键字搜索群信息
     *  混合搜索高级群和超大群，like匹配
     *  只搜索群名称
     *  不限制群有效性，不限制是否加入，不限制群是否有效
     *  基于本地数据存储查找
     * @param keyword 关键字
     * @param success
     * @param failure
     */
    void searchTeamByKeyword(String keyword, V2NIMSuccessCallback<List<V2NIMTeam>> success, V2NIMFailureCallback failure);

    /**
     * 全文检索群信息，可以指定检索群名称
     *  客户端返回全量命中的群， 按群创建时间倒序返回
     * @param params 群信息检索参数
     * @param success 检索成功回调
     * @param failure 检索失败回调
     */
    void searchTeams(V2NIMTeamSearchParams params, V2NIMSuccessCallback<List<V2NIMTeam>> success, V2NIMFailureCallback failure);


    /**
     * 根据关键字搜索群成员
     * @param searchOption 搜索参数
     * @param success
     * @param failure
     */
    void searchTeamMembers(V2NIMTeamMemberSearchOption searchOption, V2NIMSuccessCallback<V2NIMTeamMemberSearchResult> success, V2NIMFailureCallback failure);

    /**
     * 添加群组成员关注
     * @param teamId 群组id,群组 ID 为空报错 191004 参数错误
     * @param teamType 群组类型,群组类型不是高级群或超级群，报错 191004 参数错误
     * @param accountIds 账号id列表,为null 或 size==0，返回 191004 参数错误
     * @param success 成功回调
     * @param failure 失败回调
     */
    void addTeamMembersFollow(String teamId,V2NIMTeamType teamType, List<String> accountIds, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 移除群组成员关注
     * @param teamId 群组id,群组 ID 为空报错 191004 参数错误
     * @param teamType 群组类型,群组类型不是高级群或超级群，报错 191004 参数错误
     * @param accountIds 账号id列表,为null 或 size==0，返回 191004 参数错误
     * @param success 成功回调
     * @param failure 失败回调
     */
    void removeTeamMembersFollow(String teamId,V2NIMTeamType teamType, List<String> accountIds, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

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

    /**
     * 清空所有群申请
     * @param option 清空群申请参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void clearAllTeamJoinActionInfoEx(V2NIMTeamClearJoinActionInfoOption option,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 删除群申请
     * @param application
     * @param success
     * @param failure
     */
    void deleteTeamJoinActionInfo(V2NIMTeamJoinActionInfo application, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 设置群申请已读
     * 如果参数不为空：标记同一组(群ID,群type,且申请者相同)相关申请信息为已读
     * 否则：历史数据未读数据均标记为已读
     * @param application 群申请信息
     * @param success
     * @param failure
     */
    void setTeamJoinActionInfoRead(V2NIMTeamJoinActionInfo application,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 获取群申请/邀请未读数量
     * @param success
     * @param failure
     */
    void getTeamJoinActionInfoUnreadCount(V2NIMSuccessCallback<Integer> success, V2NIMFailureCallback failure);

    /**
     * 全文检索群成员信息，可以指定是否检索群成员ID或者群成员昵称
     * @param searchParams
     * @param success
     * @param failure
     */
    void searchTeamMembersEx(V2NIMSearchTeamMemberParams searchParams, V2NIMSuccessCallback<Map<V2NIMTeamRefer, List<V2NIMTeamMember>>> success, V2NIMFailureCallback failure);

    /**
     * 添加群组监听
     * @param listener 群组监听
     */
    void addTeamListener(V2NIMTeamListener listener);

    /**
     * 移除群组监听
     * @param listener 群组监听
     */
    void removeTeamListener(V2NIMTeamListener listener);

}