QChatRoleService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.qchat.param.QChatAddChannelCategoryMemberRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatAddChannelCategoryRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatAddChannelRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatAddMemberRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatAddMembersToServerRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatCheckPermissionParam;
import com.netease.nimlib.sdk.qchat.param.QChatCheckPermissionsParam;
import com.netease.nimlib.sdk.qchat.param.QChatCreateServerRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatDeleteServerRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelCategoryMemberRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelCategoryRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetChannelRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetExistingAccidsInServerRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetExistingAccidsOfMemberRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetExistingChannelRolesByServerRoleIdsParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetExistingServerRolesByAccidsParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetMemberRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetMembersFromServerRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetServerRolesByAccidParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetServerRolesParam;
import com.netease.nimlib.sdk.qchat.param.QChatRemoveChannelCategoryMemberRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatRemoveChannelCategoryRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatRemoveChannelRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatRemoveMemberRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatRemoveMembersFromServerRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelCategoryMemberRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelCategoryRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateChannelRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateMemberRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateServerRoleParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateServerRolePrioritiesParam;
import com.netease.nimlib.sdk.qchat.result.QChatAddChannelCategoryMemberRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatAddChannelCategoryRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatAddChannelRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatAddMemberRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatAddMembersToServerRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatCheckPermissionResult;
import com.netease.nimlib.sdk.qchat.result.QChatCheckPermissionsResult;
import com.netease.nimlib.sdk.qchat.result.QChatCreateServerRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoryMemberRolesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoryRolesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetChannelRolesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetExistingAccidsInServerRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetExistingAccidsOfMemberRolesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelRolesByServerRoleIdsResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetExistingServerRolesByAccidsResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetMemberRolesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetMembersFromServerRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetServerRolesByAccidResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetServerRolesResult;
import com.netease.nimlib.sdk.qchat.result.QChatRemoveMembersFromServerRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelCategoryMemberRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelCategoryRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateMemberRoleResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateServerRolePrioritiesResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateServerRoleResult;

@NIMService("圈组身份组服务")
public interface QChatRoleService {

    /**
     * 新增服务器身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatCreateServerRoleResult> createServerRole(QChatCreateServerRoleParam param);

    /**
     * 移除服务器身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<Void> deleteServerRole(QChatDeleteServerRoleParam param);

    /**
     * 修改服务器身份组信息
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatUpdateServerRoleResult> updateServerRole(QChatUpdateServerRoleParam param);

    /**
     * 批量修改服务器身份组优先级
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatUpdateServerRolePrioritiesResult> updateServerRolePriorities(QChatUpdateServerRolePrioritiesParam param);

    /**
     * 查询服务器下身份组列表，第一页返回结果额外包含everyone身份组，自定义身份组数量充足的情况下会返回limit+1个身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetServerRolesResult> getServerRoles(QChatGetServerRolesParam param);

    /**
     * 新增Channel身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatAddChannelRoleResult> addChannelRole(QChatAddChannelRoleParam param);

    /**
     * 删除频道身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<Void> removeChannelRole(QChatRemoveChannelRoleParam param);

    /**
     * 修改频道下某身份组的权限
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatUpdateChannelRoleResult> updateChannelRole(QChatUpdateChannelRoleParam param);

    /**
     * 查询某频道下的身份组信息列表
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetChannelRolesResult> getChannelRoles(QChatGetChannelRolesParam param);

    /**
     * 为某个人定制某频道的权限
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatAddMemberRoleResult> addMemberRole(QChatAddMemberRoleParam param);

    /**
     * 删除频道下某人的定制权限
     *
     * @param param
     * @return
     */
    InvocationFuture<Void> removeMemberRole(QChatRemoveMemberRoleParam param);

    /**
     * 修改某人的定制权限
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatUpdateMemberRoleResult> updateMemberRole(QChatUpdateMemberRoleParam param);

    /**
     * 查询channel下某人的定制权限
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetMemberRolesResult> getMemberRoles(QChatGetMemberRolesParam param);

    /**
     * 将某些人加入某服务器身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatAddMembersToServerRoleResult> addMembersToServerRole(QChatAddMembersToServerRoleParam param);

    /**
     * 将某些人移出某服务器身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatRemoveMembersFromServerRoleResult> removeMembersFromServerRole(QChatRemoveMembersFromServerRoleParam param);

    /**
     * 查询某服务器下某身份组下的成员列表
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetMembersFromServerRoleResult> getMembersFromServerRole(QChatGetMembersFromServerRoleParam param);

    /**
     * 通过accid查询该accid所属的服务器身份组列表，结果只有自定义身份组，不包含everyone身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetServerRolesByAccidResult> getServerRolesByAccid(QChatGetServerRolesByAccidParam param);

    /**
     * 通过accid查询该accid所属的服务器身份组列表，结果只有自定义身份组，不包含everyone身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetExistingServerRolesByAccidsResult> getExistingServerRolesByAccids(QChatGetExistingServerRolesByAccidsParam param);

    /**
     * 查询一批accids在某个服务器身份组下存在的列表
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetExistingAccidsInServerRoleResult> getExistingAccidsInServerRole(QChatGetExistingAccidsInServerRoleParam param);

    /**
     * 通过服务器身份组Id列表查询频道身份组列表
     *
     * 传入服务器Id，频道Id，和一组该服务器下的身份组Id组成的列表，
     * 找出该身份组Id列表中被添加到频道Id所在频道的服务器身份组，并返回这些服务器身份组被添加到频道后的频道身份列表
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetExistingChannelRolesByServerRoleIdsResult> getExistingChannelRolesByServerRoleIds(QChatGetExistingChannelRolesByServerRoleIdsParam param);

    /**
     * 查询一批accids中定制了服务器身份组的列表
     *
     * 输入accid列表和频道Id，查询这些用户在该频道下的成员定制权限，返回这些定制权限的accid列表
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetExistingAccidsOfMemberRolesResult> getExistingAccidsOfMemberRoles(QChatGetExistingAccidsOfMemberRolesParam param);

    /**
     * 查询自己是否拥有某个权限
     * @param param
     * @return
     */
    InvocationFuture<QChatCheckPermissionResult> checkPermission(QChatCheckPermissionParam param);

    /**
     * 新增频道分组身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatAddChannelCategoryRoleResult> addChannelCategoryRole(QChatAddChannelCategoryRoleParam param);

    /**
     * 删除频道分组身份组
     *
     * @param param
     * @return
     */
    InvocationFuture<Void> removeChannelCategoryRole(QChatRemoveChannelCategoryRoleParam param);

    /**
     * 修改频道分组身份组权限
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatUpdateChannelCategoryRoleResult> updateChannelCategoryRole(QChatUpdateChannelCategoryRoleParam param);

    /**
     * 查询频道分组身份组信息
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetChannelCategoryRolesResult> getChannelCategoryRoles(QChatGetChannelCategoryRolesParam param);

    /**
     * 创建频道分组某人的定制权限
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatAddChannelCategoryMemberRoleResult> addChannelCategoryMemberRole(QChatAddChannelCategoryMemberRoleParam param);

    /**
     * 删除频道分组某人的定制权限
     *
     * @param param
     * @return
     */
    InvocationFuture<Void> removeChannelCategoryMemberRole(QChatRemoveChannelCategoryMemberRoleParam param);

    /**
     * 修改频道分组某人的定制权限
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatUpdateChannelCategoryMemberRoleResult> updateChannelCategoryMemberRole(QChatUpdateChannelCategoryMemberRoleParam param);

    /**
     * 查询频道分组下某人的定制权限
     *
     * @param param
     * @return
     */
    InvocationFuture<QChatGetChannelCategoryMemberRolesResult> getChannelCategoryMemberRoles(QChatGetChannelCategoryMemberRolesParam param);

    /**
     * 查询自己是否拥有某些权限
     * @param param
     * @return
     */
    InvocationFuture<QChatCheckPermissionsResult> checkPermissions(QChatCheckPermissionsParam param);
}