io.gitee.huangguiming.Imcode.apiUrl.IMAPiAddressUrl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of imsdk Show documentation
imsdk即时通讯快速开发
There is a newer version: 1.0.4
package io.gitee.huangguiming.Imcode.apiUrl;

import lombok.AllArgsConstructor;
import lombok.Getter;

/**
 * IM即使通讯的链接地址
 */
public interface IMAPiAddressUrl {
    public static final String IMHOST = "https://console.tim.qq.com/";


    default String getUrl() {
        return  this.getPrefix()+ this.getPath();
    }
    String getPath();

    /**
     * the prefix
     *
     * @return prefix
     */
    String getPrefix();

    /**
     * 群组相关接口
     */
    @AllArgsConstructor
    @Getter
    enum Group implements IMAPiAddressUrl{
        /**
         * 查询所有群组
         */
        SELECT_ALL_GROUP (IMHOST,"v4/group_open_http_svc/get_appid_group_list"),

        /**
         * 创建群主
         */
        CREATE_GROUP(IMHOST,"v4/group_open_http_svc/create_group"),

        /**
         * 获取群详细资料
         */
        GET_GROUP_INFO(IMHOST,"v4/group_open_http_svc/get_group_info"),

        /**
         * 获取群成员详细资料
         */
        GET_GROUP_MEMBER_INFO(IMHOST,"v4/group_open_http_svc/get_group_member_info"),

        /**
         * 修改群基础资料
         */
        UPDATE_GROUP_INFO(IMHOST,"v4/group_open_http_svc/modify_group_base_info"),

        /**
         * 增加群成员
         */
        ADD_GROUP_MEMBER(IMHOST,"v4/group_open_http_svc/add_group_member"),

        /**
         * 删除群成员
         */
        DELETE_GROUP_MEMBER(IMHOST,"v4/group_open_http_svc/delete_group_member"),

        /**
         * 修改群成员资料
         */
        UPDATE_GROUP_MEMBER_INFO(IMHOST,"v4/group_open_http_svc/modify_group_member_info"),

        /**
         * 解散群组
         */
        DESTROY_GROUP(IMHOST,"v4/group_open_http_svc/destroy_group"),

        /**
         * 获取用户所加入的群组
         */
        GET_USER_JOINED_GROUP(IMHOST,"v4/group_open_http_svc/get_joined_group_list"),

        /**
         * 查询用户在群组中的身份
         */
        SELECT_USER_IN_GROUP_ROLE(IMHOST,"v4/group_open_http_svc/get_role_in_group"),

        /**
         * 批量禁言和取消禁言
         */
        FORBID_SEND_MSG(IMHOST,"v4/group_open_http_svc/forbid_send_msg"),

        /**
         * 获取禁言的用户列表
         */
        GET_GROUP_FORBID_SEND_MSG_USER_LIST(IMHOST,"v4/group_open_http_svc/get_group_shutted_uin"),

        /**
         * 在群组中发送普通消息
         */
        SEND_GROUP_MSG(IMHOST,"v4/group_open_http_svc/send_group_msg"),

        /**
         * 在群组中发送系统通知
         */
        SEND_GROUP_SYSTEM_MSG(IMHOST,"v4/group_open_http_svc/send_group_system_notification"),

        /**
         * 撤回群消息
         */
        GROUP_MSG_RECALL(IMHOST,"v4/group_open_http_svc/group_msg_recall"),

        /**
         * 转让群主
         */
        CHANGE_GROUP_OWNER(IMHOST,"v4/group_open_http_svc/change_group_owner"),

        /**
         * 导入群基础资料
         */
        IMPORT_GROUP(IMHOST,"v4/group_open_http_svc/import_group"),

        /**
         * 导入群消息
         */
        IMPORT_GROUP_MSG(IMHOST,"v4/group_open_http_svc/import_group_msg"),

        /**
         * 导入群成员
         */
        IMPORT_GROUP_USER_LIST(IMHOST,"v4/group_open_http_svc/import_group_member"),

        /**
         * 设置成员未读消息计数
         */
        SET_UNREAD_MSG_NUM(IMHOST,"v4/group_open_http_svc/set_unread_msg_num"),

        /**
         * 删除指定用户发送的消息
         */
        DELETE_GROUP_MSG_BY_SENDER(IMHOST,"v4/group_open_http_svc/delete_group_msg_by_sender"),

        /**
         * 拉取群历史消息
         */
        GROUP_MSG_GET_SIMPLE(IMHOST,"v4/group_open_http_svc/group_msg_get_simple"),

        /**
         * 获取直播在线人数
         */
        GET_ONLINE_MEMBER_NUM(IMHOST,"v4/group_open_http_svc/get_online_member_num");


        private final String prefix;
        private final String path;
    }

    /**
     * 禁言相关
     */
    @AllArgsConstructor
    @Getter
    enum NoSpeaking implements IMAPiAddressUrl{

        /**
         * 设置全局禁言
         */
        SET_NO_SPEAKING(IMHOST,"v4/openconfigsvr/setnospeaking"),

        /**
         * 查询全局禁言
         */
        GET_NO_SPEAKING(IMHOST,"v4/openconfigsvr/getnospeaking");

        private final String prefix;
        private final String path;
    }
}