QChatServerService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat;

import androidx.annotation.NonNull;
import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.qchat.param.QChatAcceptServerApplyParam;
import com.netease.nimlib.sdk.qchat.param.QChatAcceptServerInviteParam;
import com.netease.nimlib.sdk.qchat.param.QChatApplyServerJoinParam;
import com.netease.nimlib.sdk.qchat.param.QChatBanServerMemberParam;
import com.netease.nimlib.sdk.qchat.param.QChatCreateServerParam;
import com.netease.nimlib.sdk.qchat.param.QChatDeleteServerParam;
import com.netease.nimlib.sdk.qchat.param.QChatEnterServerAsVisitorParam;
import com.netease.nimlib.sdk.qchat.param.QChatGenerateInviteCodeParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetBannedServerMembersByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetInviteApplyRecordOfSelfParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetInviteApplyRecordOfServerParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetServerMembersByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetServerMembersParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetServerMuteMemberByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetServersByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetServersParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetUserServerPushConfigsParam;
import com.netease.nimlib.sdk.qchat.param.QChatInviteServerMembersParam;
import com.netease.nimlib.sdk.qchat.param.QChatJoinByInviteCodeParam;
import com.netease.nimlib.sdk.qchat.param.QChatKickServerMembersParam;
import com.netease.nimlib.sdk.qchat.param.QChatLeaveServerAsVisitorParam;
import com.netease.nimlib.sdk.qchat.param.QChatLeaveServerParam;
import com.netease.nimlib.sdk.qchat.param.QChatRejectServerApplyParam;
import com.netease.nimlib.sdk.qchat.param.QChatRejectServerInviteParam;
import com.netease.nimlib.sdk.qchat.param.QChatSearchServerByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatSearchServerMemberByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatServerMarkReadParam;
import com.netease.nimlib.sdk.qchat.param.QChatServerMuteParam;
import com.netease.nimlib.sdk.qchat.param.QChatSubscribeAllChannelParam;
import com.netease.nimlib.sdk.qchat.param.QChatSubscribeServerAsVisitorParam;
import com.netease.nimlib.sdk.qchat.param.QChatSubscribeServerParam;
import com.netease.nimlib.sdk.qchat.param.QChatUnbanServerMemberParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateMyMemberInfoParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateServerMemberInfoParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateServerParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateUserServerPushConfigParam;
import com.netease.nimlib.sdk.qchat.result.QChatApplyServerJoinResult;
import com.netease.nimlib.sdk.qchat.result.QChatCreateServerResult;
import com.netease.nimlib.sdk.qchat.result.QChatEnterServerAsVisitorResult;
import com.netease.nimlib.sdk.qchat.result.QChatGenerateInviteCodeResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetBannedServerMembersByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetInviteApplyRecordOfSelfResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetInviteApplyRecordOfServerResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetServerMembersByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetServerMembersResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetServerMuteMemberByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetServersByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetServersResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetUserPushConfigsResult;
import com.netease.nimlib.sdk.qchat.result.QChatInviteServerMembersResult;
import com.netease.nimlib.sdk.qchat.result.QChatLeaveServerAsVisitorResult;
import com.netease.nimlib.sdk.qchat.result.QChatMuteResult;
import com.netease.nimlib.sdk.qchat.result.QChatSearchServerByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatSearchServerMemberByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatServerMarkReadResult;
import com.netease.nimlib.sdk.qchat.result.QChatSubscribeAllChannelResult;
import com.netease.nimlib.sdk.qchat.result.QChatSubscribeServerAsVisitorResult;
import com.netease.nimlib.sdk.qchat.result.QChatSubscribeServerResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateMyMemberInfoResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateServerMemberInfoResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateServerResult;

@NIMService("圈组服务器服务")
public interface QChatServerService {
    /**
     * 接受申请
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> acceptServerApply(QChatAcceptServerApplyParam param);

    /**
     * 接受邀请
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> acceptServerInvite(QChatAcceptServerInviteParam param);

    /**
     * 申请加入服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatApplyServerJoinResult> applyServerJoin(QChatApplyServerJoinParam param);

    /**
     * 创建服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回创建成功的服务器
     */
    InvocationFuture<QChatCreateServerResult> createServer(QChatCreateServerParam param);

    /**
     * 删除服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> deleteServer(QChatDeleteServerParam param);

    /**
     * 通过accid查询服务器成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的服务器成员
     */
    InvocationFuture<QChatGetServerMembersResult> getServerMembers(QChatGetServerMembersParam param);

    /**
     * 通过分页信息查询服务器成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的服务器成员
     */
    InvocationFuture<QChatGetServerMembersByPageResult> getServerMembersByPage(QChatGetServerMembersByPageParam param);

    /**
     * 通过ServerId列表查询服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的服务器列表
     */
    InvocationFuture<QChatGetServersResult> getServers(QChatGetServersParam param);

    /**
     * 通过分页信息查询服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的服务器列表
     */
    InvocationFuture<QChatGetServersByPageResult> getServersByPage(QChatGetServersByPageParam param);

    /**
     * 邀请服务器成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatInviteServerMembersResult> inviteServerMembers(QChatInviteServerMembersParam param);

    /**
     * 踢除服务器成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> kickServerMembers(QChatKickServerMembersParam param);

    /**
     * 主动离开服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> leaveServer(QChatLeaveServerParam param);

    /**
     * 拒绝申请
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> rejectServerApply(QChatRejectServerApplyParam param);

    /**
     * 拒绝邀请
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> rejectServerInvite(QChatRejectServerInviteParam param);

    /**
     * 修改服务器信息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatUpdateServerResult> updateServer(QChatUpdateServerParam param);

    /**
     * 修改其他人的服务器成员信息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatUpdateServerMemberInfoResult> updateServerMemberInfo(QChatUpdateServerMemberInfoParam param);

    /**
     * 修改服务器成员信息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatUpdateMyMemberInfoResult> updateMyMemberInfo(QChatUpdateMyMemberInfoParam param);

    /**
     * 订阅服务器
     * 与你相关的系统通知，比如你被邀请加入服务器、你从服务器被踢等，不需要订阅就可以收到
     * 与你不相关的系统通知，大服务器下需要主动订阅服务器才能收到，小服务器下不需要订阅就可以收到
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回订阅结果
     */
    InvocationFuture<QChatSubscribeServerResult> subscribeServer(QChatSubscribeServerParam param);

    /**
     * 封禁服务器成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> banServerMember(QChatBanServerMemberParam param);

    /**
     * 解封服务器成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> unbanServerMember(QChatUnbanServerMemberParam param);

    /**
     * 查询服务器封禁成员列表(分页)
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatGetBannedServerMembersByPageResult> getBannedServerMembersByPage(QChatGetBannedServerMembersByPageParam param);

    /**
     * 更新用户服务器推送配置
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<Void> updateUserServerPushConfig(QChatUpdateUserServerPushConfigParam param);

    /**
     * 获取用户服务器推送配置列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatGetUserPushConfigsResult> getUserServerPushConfigs(QChatGetUserServerPushConfigsParam param);

    /**
     * 分页检索服务器列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatSearchServerByPageResult> searchServerByPage(@NonNull QChatSearchServerByPageParam param);

    /**
     * 检索服务器成员列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatSearchServerMemberByPageResult> searchServerMemberByPage(@NonNull QChatSearchServerMemberByPageParam param);


    /**
     * 生成邀请码
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatGenerateInviteCodeResult> generateInviteCode(@NonNull QChatGenerateInviteCodeParam param);

    /**
     * 通过邀请码加入服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<Void> joinByInviteCode(@NonNull QChatJoinByInviteCodeParam param);

    /**
     * 查询服务器下的申请邀请记录
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatGetInviteApplyRecordOfServerResult> getInviteApplyRecordOfServer(@NonNull QChatGetInviteApplyRecordOfServerParam param);

    /**
     * 查询我的申请邀请记录
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatGetInviteApplyRecordOfSelfResult> getInviteApplyRecordOfSelf(@NonNull QChatGetInviteApplyRecordOfSelfParam param);

    /**
     * 清空服务器未读数
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatServerMarkReadResult> markRead(@NonNull QChatServerMarkReadParam param);

    /**
     * 订阅服务器下的所有频道的消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatSubscribeAllChannelResult> subscribeAllChannel(@NonNull QChatSubscribeAllChannelParam param);

    /**
     * 以游客身份订阅服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回订阅结果
     */
    InvocationFuture<QChatSubscribeServerAsVisitorResult> subscribeAsVisitor(QChatSubscribeServerAsVisitorParam param);

    /**
     * 以游客身份加入服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回订阅结果
     */
    InvocationFuture<QChatEnterServerAsVisitorResult> enterAsVisitor(QChatEnterServerAsVisitorParam param);

    /**
     * 以游客身份离开服务器
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回订阅结果
     */
    InvocationFuture<QChatLeaveServerAsVisitorResult> leaveAsVisitor(QChatLeaveServerAsVisitorParam param);

    /**
     * 禁言服务器成员
     * @param param
     * @return
     */
    InvocationFuture<QChatMuteResult> mute(QChatServerMuteParam param);

    /**
     * 分页获取服务器禁言成员列表
     * @param param
     * @return
     */
    InvocationFuture<QChatGetServerMuteMemberByPageResult> getMuteMemberByPage(QChatGetServerMuteMemberByPageParam param);
}