QChatRoleResource.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat.enums;

import androidx.annotation.NonNull;
import com.netease.nimlib.util.StringUtil;
import java.io.Serializable;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Objects;

/**
 * 身份组权限资源项
 */
public class QChatRoleResource implements Serializable, Comparable<QChatRoleResource> {
    /**
     * 管理服务器：修改服务器,仅server有
     * */
    public static final QChatRoleResource MANAGE_SERVER = new QChatRoleResource(1,1, "MANAGE_SERVER", 0);
    /**
     * 管理频道，server和channel都有
     * */
    public static final QChatRoleResource MANAGE_CHANNEL = new QChatRoleResource(2,0, "MANAGE_CHANNEL", 1);
    /**
     * 管理身份组的权限，server和channel都有
     * */
    public static final QChatRoleResource MANAGE_ROLE = new QChatRoleResource(3,0, "MANAGE_ROLE", 2);
    /**
     * 发送消息，server和channel都有
     * */
    public static final QChatRoleResource SEND_MSG = new QChatRoleResource(4,0, "SEND_MSG", 3);
    /**
     * 修改自己在该server的服务器成员信息，仅server有
     * */
    public static final QChatRoleResource ACCOUNT_INFO_SELF = new QChatRoleResource(5,1, "ACCOUNT_INFO_SELF", 4);
    /**
     * 邀请他人进入server的，仅server有
     * */
    public static final QChatRoleResource INVITE_SERVER = new QChatRoleResource(6,1, "INVITE_SERVER", 5);
    /**
     * 踢除他人的权限，仅server有
     * */
    public static final QChatRoleResource KICK_SERVER = new QChatRoleResource(7,1, "KICK_SERVER", 6);
    /**
     * 修改他人在该server的服务器成员信息，仅server有
     * */
    public static final QChatRoleResource ACCOUNT_INFO_OTHER = new QChatRoleResource(8,1, "ACCOUNT_INFO_OTHER", 7);
    /**
     * 撤回他人消息的权限，server和channel都有
     *  */
    public static final QChatRoleResource RECALL_MSG = new QChatRoleResource(9,0, "RECALL_MSG", 8);
    /**
     * 删除他人消息的权限，server和channel都有
     * */
    public static final QChatRoleResource DELETE_MSG = new QChatRoleResource(10,0, "DELETE_MSG", 9);
    /**
     *  @ 他人的权限，server和channel都有
     * */
    public static final QChatRoleResource REMIND_OTHER = new QChatRoleResource(11,0, "REMIND_OTHER", 10);
    /**
     *  @ everyone，server和channel都有
     * */
    public static final QChatRoleResource REMIND_EVERYONE = new QChatRoleResource(12,0, "REMIND_EVERYONE", 11);
    /**
     *  管理黑白名单的权限，server和channel都有
     * */
    public static final QChatRoleResource MANAGE_BLACK_WHITE_LIST = new QChatRoleResource(13,0, "MANAGE_BLACK_WHITE_LIST", 12);
    /**
     *  封禁他人的权限，仅server有，允许成员永久封禁其他成员访问此服务器
     * */
    public static final QChatRoleResource BAN_SERVER_MEMBER = new QChatRoleResource(14,1, "BAN_SERVER_MEMBER", 13);
    /**
     *  RTC频道：连接的权限
     * */
    public static final QChatRoleResource RTC_CHANNEL_CONNECT = new QChatRoleResource(15, 0, "RTC_CHANNEL_CONNECT", 14);
    /**
     *  RTC频道：断开他人连接的权限
     * */
    public static final QChatRoleResource RTC_CHANNEL_DISCONNECT_OTHER = new QChatRoleResource(16, 0, "RTC_CHANNEL_DISCONNECT_OTHER", 15);
    /**
     *  RTC频道：开启麦克风的权限
     * */
    public static final QChatRoleResource RTC_CHANNEL_OPEN_MICROPHONE = new QChatRoleResource(17, 0, "RTC_CHANNEL_OPEN_MICROPHONE", 16);
    /**
     *  RTC频道：开启摄像头的权限
     * */
    public static final QChatRoleResource RTC_CHANNEL_OPEN_CAMERA = new QChatRoleResource(18, 0, "RTC_CHANNEL_OPEN_CAMERA", 17);
    /**
     *  RTC频道：开启/关闭他人麦克风的权限
     * */
    public static final QChatRoleResource RTC_CHANNEL_OPEN_CLOSE_OTHER_MICROPHONE = new QChatRoleResource(19, 0, "RTC_CHANNEL_OPEN_CLOSE_OTHER_MICROPHONE", 18);
    /**
     *  RTC频道：开启/关闭他人摄像头的权限
     * */
    public static final QChatRoleResource RTC_CHANNEL_OPEN_CLOSE_OTHER_CAMERA = new QChatRoleResource(20, 0, "RTC_CHANNEL_OPEN_CLOSE_OTHER_CAMERA", 19);
    /**
     *  RTC频道：开启/关闭全员麦克风的权限
     * */
    public static final QChatRoleResource RTC_CHANNEL_OPEN_CLOSE_EVERYONE_MICROPHONE = new QChatRoleResource(21, 0, "RTC_CHANNEL_OPEN_CLOSE_EVERYONE_MICROPHONE", 20);
    /**
     *  RTC频道：开启/关闭全员摄像头的权限
     * */
    public static final QChatRoleResource RTC_CHANNEL_OPEN_CLOSE_EVERYONE_CAMERA = new QChatRoleResource(22, 0, "RTC_CHANNEL_OPEN_CLOSE_EVERYONE_CAMERA", 21);
    /**
     * RTC频道：打开自己屏幕共享的权限
     */
    public static final QChatRoleResource RTC_CHANNEL_OPEN_SCREEN_SHARE = new QChatRoleResource(23, 0, "RTC_CHANNEL_OPEN_SCREEN_SHARE", 22);
    /**
     * RTC频道：关闭他人屏幕共享的权限
     */
    public static final QChatRoleResource RTC_CHANNEL_CLOSE_OTHER_SCREEN_SHARE = new QChatRoleResource(24, 0, "RTC_CHANNEL_CLOSE_OTHER_SCREEN_SHARE", 23);
    /**
     * 服务器申请处理权限
     */
    public static final QChatRoleResource SERVER_APPLY_HANDLE = new QChatRoleResource(25, 1, "SERVER_APPLY_HANDLE", 24);
    /**
     * 申请邀请历史查看权限，有这个权限才可以查询server级别的申请/邀请记录
     */
    public static final QChatRoleResource INVITE_APPLY_HISTORY_QUERY = new QChatRoleResource(26, 1, "INVITE_APPLY_HISTORY_QUERY", 25);

    /**
     * \@身份组的权限，server和channel都有
     */
    public static final QChatRoleResource MENTIONED_ROLE = new QChatRoleResource(27, 0, "MENTIONED_ROLE", 26);
    /**
     * 禁言权限
     */
    public static final QChatRoleResource MUTE = new QChatRoleResource(28, 0, "MUTE", 27);

    /** 添加新的枚举项需要同步更新{@link ROLE_MAP} */
    ;

    private final int resource;
    /**
     * 0是所有
     * 1是server
     * 2是channel
     * */
    private final int type;

    /**
     * 模拟枚举类型的变量名
     * @see Enum#name()
     */
    public final String name;
    /**
     * 模拟枚举类型的序号
     * @see Enum#ordinal()
     */
    public final int ordinal;
    @SuppressWarnings("java:S3599")
    private static final Map<String, QChatRoleResource> ROLE_MAP = new LinkedHashMap<String, QChatRoleResource>() {
        {
            put("MANAGE_SERVER", MANAGE_SERVER);
            put("MANAGE_CHANNEL", MANAGE_CHANNEL);
            put("MANAGE_ROLE", MANAGE_ROLE);
            put("SEND_MSG", SEND_MSG);
            put("ACCOUNT_INFO_SELF", ACCOUNT_INFO_SELF);
            put("INVITE_SERVER", INVITE_SERVER);
            put("KICK_SERVER", KICK_SERVER);
            put("ACCOUNT_INFO_OTHER", ACCOUNT_INFO_OTHER);
            put("RECALL_MSG", RECALL_MSG);
            put("DELETE_MSG", DELETE_MSG);
            put("REMIND_OTHER", REMIND_OTHER);
            put("REMIND_EVERYONE", REMIND_EVERYONE);
            put("MANAGE_BLACK_WHITE_LIST", MANAGE_BLACK_WHITE_LIST);
            put("BAN_SERVER_MEMBER", BAN_SERVER_MEMBER);
            put("RTC_CHANNEL_CONNECT", RTC_CHANNEL_CONNECT);
            put("RTC_CHANNEL_DISCONNECT_OTHER", RTC_CHANNEL_DISCONNECT_OTHER);
            put("RTC_CHANNEL_OPEN_MICROPHONE", RTC_CHANNEL_OPEN_MICROPHONE);
            put("RTC_CHANNEL_OPEN_CAMERA", RTC_CHANNEL_OPEN_CAMERA);
            put("RTC_CHANNEL_OPEN_CLOSE_OTHER_MICROPHONE", RTC_CHANNEL_OPEN_CLOSE_OTHER_MICROPHONE);
            put("RTC_CHANNEL_OPEN_CLOSE_OTHER_CAMERA", RTC_CHANNEL_OPEN_CLOSE_OTHER_CAMERA);
            put("RTC_CHANNEL_OPEN_CLOSE_EVERYONE_MICROPHONE", RTC_CHANNEL_OPEN_CLOSE_EVERYONE_MICROPHONE);
            put("RTC_CHANNEL_OPEN_CLOSE_EVERYONE_CAMERA", RTC_CHANNEL_OPEN_CLOSE_EVERYONE_CAMERA);
            put("RTC_CHANNEL_OPEN_SCREEN_SHARE", RTC_CHANNEL_OPEN_SCREEN_SHARE);
            put("RTC_CHANNEL_CLOSE_OTHER_SCREEN_SHARE", RTC_CHANNEL_CLOSE_OTHER_SCREEN_SHARE);
            put("SERVER_APPLY_HANDLE", SERVER_APPLY_HANDLE);
            put("INVITE_APPLY_HISTORY_QUERY", INVITE_APPLY_HISTORY_QUERY);
            put("MENTIONED_ROLE", MENTIONED_ROLE);
            put("MUTE", MUTE);
        }
    };


    public QChatRoleResource(int resource, int type) {
        this(resource, type, "", -1);
    }

    private QChatRoleResource(int resource, int type, @NonNull String name, int ordinal) {
        this.resource = resource;
        this.type     = type;
        this.name = name;
        this.ordinal = ordinal;
    }

    public int value() {
        return resource;
    }

    /**
     * 是否是仅Server才拥有的权限
     * @return
     */
    public boolean isOnlyServerPermission()
    {
        return type == 1;
    }

    /**
     * 是否是仅Channel才拥有的权限
     * @return
     */
    public boolean isOnlyChannelPermission()
    {
        return type == 2;
    }

    /**
     * 是否是Server和Channel都拥有的权限
     * @return
     */
    public boolean isAllPermission()
    {
        return type == 0;
    }

    /**
     * @see Enum#name()
     * @return
     */
    @NonNull
    public String name() {
        return name;
    }

    /**
     * @see Enum#ordinal()
     * @return
     */
    public int ordinal() {
        return ordinal;
    }

    /**
     * 模拟枚举类型的对比方法
     * @see Enum#compareTo(Enum)
     * @param o 对比项
     * @return 对比结果
     */
    @Override
    public int compareTo(QChatRoleResource o) {
        return this.ordinal - o.ordinal;
    }

    /**
     * 模拟枚举类型的对应方法
     * @see Enum#getDeclaringClass()
     * @return 类
     */
    public final Class<QChatRoleResource> getDeclaringClass() {
        return QChatRoleResource.class;
    }

    @Override
    @NonNull
    public String toString() {
        return StringUtil.isEmpty(name) ? String.valueOf(resource) : name;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        QChatRoleResource resource1 = (QChatRoleResource) o;
        return resource == resource1.resource && type == resource1.type;
    }

    @Override
    public int hashCode() {
        return Objects.hash(resource, type);
    }

    public static QChatRoleResource getByValue(int value) {
        for (QChatRoleResource pt : ROLE_MAP.values()) {
            if (value == pt.value()) {
                return pt;
            }
        }
        return new QChatRoleResource(value, 0);
    }

    public static QChatRoleResource getByName(String name) {
        return ROLE_MAP.get(name);
    }

    public static QChatRoleResource[] values() {
        QChatRoleResource[] result = new QChatRoleResource[ROLE_MAP.size()];
        int index = 0;
        for (QChatRoleResource pt : ROLE_MAP.values()) {
            result[index++] = pt;
        }
        return result;
    }

    public static QChatRoleResource valueOf(String name) {
        return getByName(name);
    }
}