amesu/lib/api/channels.js

Node.js SDK for QQ Bot.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = (request) => {
    return {
        /**
         * 用于向 channel_id 指定的子频道发送消息。
         */
        sendChannelMessage(channel_id, params) {
            return request.post(`/channels/${channel_id}/messages`, params);
        },
        /**
         * 用于撤回子频道 channel_id 下的消息 message_id。
         */
        deleteChannelMessage(channel_id, message_id, hidetip = false) {
            return request.delete(`/channels/${channel_id}/messages/${message_id}?hidetip=${hidetip}`);
        },
        /**
         * 获取 channel_id 指定的子频道的详情。
         */
        getChannelInfo(channel_id) {
            return request.get(`/channels/${channel_id}`);
        },
        /**
         * 修改 channel_id 指定的子频道的信息。
         */
        updateChannelInfo(channel_id, params) {
            return request.patch(`/channels/${channel_id}`, params);
        },
        /**
         * 删除 channel_id 指定的子频道。
         */
        deleteChannel(channel_id) {
            return request.delete(`/channels/${channel_id}`);
        },
        /**
         * 获取子频道在线成员数。
         */
        getChannelOnlineNum(channel_id) {
            return request.get(`/channels/${channel_id}/online_nums`);
        },
        /**
         * 获取子频道 channel_id 下用户 user_id 的权限。
         */
        getChannelMemberPermission(channel_id, user_id) {
            return request.get(`/channels/${channel_id}/members/${user_id}/permissions`);
        },
        /**
         * 用于修改子频道 channel_id 下用户 user_id 的权限。
         */
        updateChannelMemberPermission(channel_id, user_id, params) {
            return request.put(`/channels/${channel_id}/members/${user_id}/permissions`, params);
        },
        /**
         * 获取子频道 channel_id 下身份组 role_id 的权限。
         */
        getChannelRolePermission(channel_id, role_id) {
            return request.get(`/channels/${channel_id}/roles/${role_id}/permissions`);
        },
        /**
         * 修改子频道 channel_id 下身份组 role_id 的权限。
         */
        updateChannelRolePermission(channel_id, role_id, params) {
            return request.put(`/channels/${channel_id}/roles/${role_id}/permissions`, params);
        },
        /**
         * 用于添加子频道 channel_id 内的精华消息。
         */
        addChannelPin(channel_id, message_id) {
            return request.put(`/channels/${channel_id}/pins/${message_id}`);
        },
        /**
         * 用于删除子频道 channel_id 下指定 message_id 的精华消息。
         */
        deleteChannelPin(channel_id, message_id) {
            return request.delete(`/channels/${channel_id}/pins/${message_id}`);
        },
        /**
         * 用于获取子频道 channel_id 内的精华消息。
         */
        getChannelPin(channel_id) {
            return request.get(`/channels/${channel_id}/pins`);
        },
        /**
         * 用于获取channel_id指定的子频道中当天的日程列表。
         */
        getChannelSchedule(channel_id, since) {
            return request.get(`/channels/${channel_id}/schedules?since=${since}`);
        },
        /**
         * 获取日程子频道 channel_id 下 schedule_id 指定的的日程的详情。
         */
        getChannelScheduleInfo(channel_id, schedule_id) {
            return request.get(`/channels/${channel_id}/schedules/${schedule_id}`);
        },
        /**
         * 用于在 channel_id 指定的日程子频道下创建一个日程。
         */
        createChannelSchedule(channel_id, params) {
            return request.post(`/channels/${channel_id}/schedules`, params);
        },
        /**
         * 用于修改日程子频道 channel_id 下 schedule_id 指定的日程的详情。
         */
        updateChannelSchedule(channel_id, schedule_id, params) {
            return request.patch(`/channels/${channel_id}/schedules/${schedule_id}`, params);
        },
        /**
         * 用于删除日程子频道 channel_id 下 schedule_id 指定的日程。
         */
        deleteChannelSchedule(channel_id, schedule_id) {
            return request.delete(`/channels/${channel_id}/schedules/${schedule_id}`);
        },
        /**
         * 用于控制子频道 channel_id 下的音频。
         */
        channelAudioControl(channel_id, params) {
            return request.post(`/channels/${channel_id}/audio`, params);
        },
        /**
         * 机器人在 channel_id 对应的语音子频道上麦。
         */
        channelMicOn(channel_id, params) {
            return request.put(`/channels/${channel_id}/mic`, params);
        },
        /**
         * 机器人在 channel_id 对应的语音子频道下麦。
         */
        channelMicOff(channel_id, params) {
            return request.delete(`/channels/${channel_id}/mic`, params);
        },
        /**
         * 该接口用于获取子频道下的帖子列表。
         */
        getChannelThread(channel_id) {
            return request.get(`/channels/${channel_id}/threads`);
        },
        /**
         * 该接口用于获取子频道下的帖子详情。
         */
        getChannelThreadInfo(channel_id, thread_id) {
            return request.get(`/channels/${channel_id}/threads/${thread_id}`);
        },
        /**
         * 发表帖子。
         */
        createChannelThread(channel_id, params) {
            return request.put(`/channels/${channel_id}/threads`, params);
        },
        /**
         * 用于删除指定子频道下的某个帖子。
         */
        deleteChannelThread(channel_id, thread_id) {
            return request.delete(`/channels/${channel_id}/threads/${thread_id}`);
        },
    };
};