QChatChannelService.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.QChatChannelMuteParam;
import com.netease.nimlib.sdk.qchat.param.QChatCreateChannelCategoryParam;
import com.netease.nimlib.sdk.qchat.param.QChatCreateChannelParam;
import com.netease.nimlib.sdk.qchat.param.QChatDeleteChannelCategoryParam;
import com.netease.nimlib.sdk.qchat.param.QChatDeleteChannelParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelBlackWhiteMembersByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelBlackWhiteRolesByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelCategoriesByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelCategoriesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelCategoryBlackWhiteMembersByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelCategoryBlackWhiteRolesByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelMembersByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelMuteMemberByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelUnreadInfosParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelsByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelsInCategoryByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelsParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetExistingChannelBlackWhiteMembersParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetExistingChannelBlackWhiteRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetExistingChannelCategoryBlackWhiteMembersParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetExistingChannelCategoryBlackWhiteRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetUncategorizedChannelsByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetUserChannelCategoryPushConfigsParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetUserChannelPushConfigsParam;
import com.netease.nimlib.sdk.qchat.param.QChatSearchChannelByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatSearchChannelMembersParam;
import com.netease.nimlib.sdk.qchat.param.QChatSubscribeChannelAsVisitorParam;
import com.netease.nimlib.sdk.qchat.param.QChatSubscribeChannelParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateCategoryInfoOfChannelParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelBlackWhiteMembersParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelBlackWhiteRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelCategoryBlackWhiteMembersParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelCategoryBlackWhiteRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelCategoryParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateUserChannelCategoryPushConfigParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateUserChannelPushConfigParam;
import com.netease.nimlib.sdk.qchat.result.QChatCreateChannelCategoryResult;
import com.netease.nimlib.sdk.qchat.result.QChatCreateChannelResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelBlackWhiteMembersByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelBlackWhiteRolesByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoriesByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoriesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoryBlackWhiteMembersByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoryBlackWhiteRolesByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelMembersByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelMuteMemberByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelUnreadInfosResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelsByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelsInCategoryByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelsResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelBlackWhiteMembersResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelBlackWhiteRolesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelCategoryBlackWhiteMembersResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelCategoryBlackWhiteRolesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetUncategorizedChannelsByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetUserPushConfigsResult;
import com.netease.nimlib.sdk.qchat.result.QChatMuteResult;
import com.netease.nimlib.sdk.qchat.result.QChatSearchChannelByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatSearchChannelMembersResult;
import com.netease.nimlib.sdk.qchat.result.QChatSubscribeChannelAsVisitorResult;
import com.netease.nimlib.sdk.qchat.result.QChatSubscribeChannelResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateCategoryInfoOfChannelResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelCategoryResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelResult;

@NIMService("圈组频道服务")
public interface QChatChannelService {
    /**
     * 创建频道
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回创建成功的频道
     */
    InvocationFuture<QChatCreateChannelResult> createChannel(QChatCreateChannelParam param);

    /**
     * 删除频道
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> deleteChannel(QChatDeleteChannelParam param);

    /**
     * 修改频道信息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatUpdateChannelResult> updateChannel(QChatUpdateChannelParam param);

    /**
     * 通过频道Id查询频道
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的频道列表
     */
    InvocationFuture<QChatGetChannelsResult> getChannels(QChatGetChannelsParam param);

    /**
     * 通过分页接口查询频道
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的频道列表
     */
    InvocationFuture<QChatGetChannelsByPageResult> getChannelsByPage(QChatGetChannelsByPageParam param);

    /**
     * 通过分页接口查询频道成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的频道成员
     */
    InvocationFuture<QChatGetChannelMembersByPageResult> getChannelMembersByPage(QChatGetChannelMembersByPageParam param);

    /**
     * 更新频道黑白名单身份组
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> updateChannelBlackWhiteRoles(QChatUpdateChannelBlackWhiteRolesParam param);

    /**
     * 分页查询频道黑白名单身份组列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的黑白名单身份组
     */
    InvocationFuture<QChatGetChannelBlackWhiteRolesByPageResult> getChannelBlackWhiteRolesByPage(QChatGetChannelBlackWhiteRolesByPageParam param);

    /**
     * 批量查询频道黑白名单身份组列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的黑白名单身份组
     */
    InvocationFuture<QChatGetExistingChannelBlackWhiteRolesResult> getExistingChannelBlackWhiteRoles(QChatGetExistingChannelBlackWhiteRolesParam param);


    /**
     * 更新频道黑白名单成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> updateChannelBlackWhiteMembers(QChatUpdateChannelBlackWhiteMembersParam param);

    /**
     * 分页查询频道黑白名单成员列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的黑白名单成员
     */
    InvocationFuture<QChatGetChannelBlackWhiteMembersByPageResult> getChannelBlackWhiteMembersByPage(QChatGetChannelBlackWhiteMembersByPageParam param);

    /**
     * 批量查询频道黑白名单成员列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的黑白名单成员
     */
    InvocationFuture<QChatGetExistingChannelBlackWhiteMembersResult> getExistingChannelBlackWhiteMembers(QChatGetExistingChannelBlackWhiteMembersParam param);

    /**
     * 查询未读信息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的历史消息
     */
    InvocationFuture<QChatGetChannelUnreadInfosResult> getChannelUnreadInfos(QChatGetChannelUnreadInfosParam param);

    /**
     * 订阅频道
     * 大服务器下，只有订阅频道后才能收到该频道的订阅内容（消息、未读数、未读状态）；与你相关的消息不需要订阅频道就可以收到，比如@你的消息（@All的消息不属于与你相关的消息）
     * 小服务器下，不需要订阅频道就可以收到所有该服务器下所有频道的消息
     * 订阅正在输入事件不区分大服务器和小服务器，只有订阅了才会收到，默认最多订阅100个频道
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回订阅结果
     */
    InvocationFuture<QChatSubscribeChannelResult> subscribeChannel(QChatSubscribeChannelParam param);

    /**
     * 更新用户频道推送配置
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<Void> updateUserChannelPushConfig(QChatUpdateUserChannelPushConfigParam param);

    /**
     * 获取用户频道推送配置列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatGetUserPushConfigsResult> getUserChannelPushConfigs(QChatGetUserChannelPushConfigsParam param);

    /**
     * 更新用户频道分组推送配置
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<Void> updateUserChannelCategoryPushConfig(QChatUpdateUserChannelCategoryPushConfigParam param);

    /**
     * 获取用户频道分组推送配置列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatGetUserPushConfigsResult> getUserChannelCategoryPushConfigs(QChatGetUserChannelCategoryPushConfigsParam param);

    /**
     * 创建频道分组
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回创建成功的频道
     */
    InvocationFuture<QChatCreateChannelCategoryResult> createChannelCategory(QChatCreateChannelCategoryParam param);

    /**
     * 删除频道分组
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> deleteChannelCategory(QChatDeleteChannelCategoryParam param);

    /**
     * 修改频道分组信息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatUpdateChannelCategoryResult> updateChannelCategory(QChatUpdateChannelCategoryParam param);

    /**
     * 查询频道分组信息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的频道分组列表
     */
    InvocationFuture<QChatGetChannelCategoriesResult> getChannelCategories(QChatGetChannelCategoriesParam param);

    /**
     * 修改频道中的频道分组信息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<QChatUpdateCategoryInfoOfChannelResult> updateCategoryInfoOfChannel(QChatUpdateCategoryInfoOfChannelParam param);

    /**
     * 更新频道分组黑白名单身份组
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> updateChannelCategoryBlackWhiteRoles(QChatUpdateChannelCategoryBlackWhiteRolesParam param);

    /**
     * 分页查询频道分组黑白名单身份组列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的黑白名单身份组
     */
    InvocationFuture<QChatGetChannelCategoryBlackWhiteRolesByPageResult> getChannelCategoryBlackWhiteRolesByPage(
            QChatGetChannelCategoryBlackWhiteRolesByPageParam param);

    /**
     * 批量查询频道分组黑白名单身份组列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的黑白名单身份组
     */
    InvocationFuture<QChatGetExistingChannelCategoryBlackWhiteRolesResult> getExistingChannelCategoryBlackWhiteRoles(
            QChatGetExistingChannelCategoryBlackWhiteRolesParam param);

    /**
     * 更新频道分组黑白名单成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> updateChannelCategoryBlackWhiteMembers(QChatUpdateChannelCategoryBlackWhiteMembersParam param);

    /**
     * 分页查询频道分组黑白名单成员列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的黑白名单成员
     */
    InvocationFuture<QChatGetChannelCategoryBlackWhiteMembersByPageResult> getChannelCategoryBlackWhiteMembersByPage(
            QChatGetChannelCategoryBlackWhiteMembersByPageParam param);

    /**
     * 批量查询频道分组黑白名单成员列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的黑白名单成员
     */
    InvocationFuture<QChatGetExistingChannelCategoryBlackWhiteMembersResult> getExistingChannelCategoryBlackWhiteMembers(
            QChatGetExistingChannelCategoryBlackWhiteMembersParam param);

    /**
     * 分页查询服务器下频道类别列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的频道分组列表
     */
    InvocationFuture<QChatGetChannelCategoriesByPageResult> getChannelCategoriesByPage(QChatGetChannelCategoriesByPageParam param);

    /**
     * 分页查询频道分组下频道列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的频道分组列表
     */
    InvocationFuture<QChatGetChannelsInCategoryByPageResult> getChannelsInCategoryByPage(QChatGetChannelsInCategoryByPageParam param);

    /**
     * 分页检索频道列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatSearchChannelByPageResult> searchChannelByPage(QChatSearchChannelByPageParam param);

    /**
     * 检索频道内成员
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果
     */
    InvocationFuture<QChatSearchChannelMembersResult> searchChannelMembers(@NonNull QChatSearchChannelMembersParam param);

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

    /**
     * 分页查询没有频道分组的频道
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的频道列表
     */
    InvocationFuture<QChatGetUncategorizedChannelsByPageResult> getUncategorizedChannelsByPage(QChatGetUncategorizedChannelsByPageParam param);

    /**
     * 禁言频道成员
     * @param param
     * @return
     */
    InvocationFuture<QChatMuteResult> mute(QChatChannelMuteParam param);

    /**
     * 分页获取频道禁言成员列表
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的频道禁言成员列表
     */
    InvocationFuture<QChatGetChannelMuteMemberByPageResult> getMuteMemberByPage(QChatGetChannelMuteMemberByPageParam param);
}