philia
    Preparing search index...

    Interface Base

    interface Base {
        clearCache: { request: void; response: void };
        delGroup: {
            request: { block?: boolean; dismiss?: boolean; id: string };
            response: void;
        };
        delGroupMember: {
            request: { block?: boolean; id: string; uid: string };
            response: void;
        };
        delMsg: { request: { id: string }; response: void };
        delUser: { request: { block?: boolean; id: string }; response: void };
        getChatHistory: {
            request: {
                count?: number;
                id: string;
                newer?: boolean;
                type: "message" | "user" | "group";
            };
            response: Message[];
        };
        getFile: { request: { id: string }; response: BinaryFile | URLFile };
        getGroupArray: { request: void | { refresh?: boolean }; response: Group[] };
        getGroupInfo: {
            request: { id: string; refresh?: boolean };
            response: Group;
        };
        getGroupList: { request: void
        | { refresh?: boolean }; response: string[] };
        getGroupMemberArray: {
            request: { id: string; refresh?: boolean };
            response: GroupMember[];
        };
        getGroupMemberInfo: {
            request: { id: string; refresh?: boolean; uid: string };
            response: GroupMember;
        };
        getGroupMemberList: {
            request: { id: string; refresh?: boolean };
            response: string[];
        };
        getMsg: { request: { id: string }; response: Message };
        getRequestArray: {
            request:
                | void
                | { count?: number; scene?: "user_add"
                | "group_add"
                | "group_invite" };
            response: Request[];
        };
        getSelfInfo: { request: void
        | { refresh?: boolean }; response: Self };
        getUserArray: { request: void | { refresh?: boolean }; response: User[] };
        getUserInfo: { request: { id: string; refresh?: boolean }; response: User };
        getUserList: { request: void | { refresh?: boolean }; response: string[] };
        getVersion: {
            request: void;
            response: {
                impl: { id: string; name: string; version: string };
                proto: { id: string; name: string; version: string };
            };
        };
        receiveEvent: { request: { event: Handle
        | Handle[] }; response: void };
        sendMsg: {
            request: { data: Message; id: string; scene: "user" | "group" };
            response: RSendMsg;
        };
        sendMsgForward: {
            request: { id: string; mid: string; scene: "user"
            | "group" };
            response: RSendMsg;
        };
        sendMultiMsg: {
            request: { data: Forward[]; id: string; scene: "user"
            | "group" };
            response: RSendMsg[];
        };
        setGroupMemberInfo: {
            request: { data: Partial<GroupMember>; id: string; uid: string };
            response: void;
        };
        setInfo: {
            request: {
                data: Partial<User | Group>;
                id: string;
                scene: "user" | "group";
            };
            response: void;
        };
        setRequest: {
            request: {
                block?: boolean;
                id: string;
                reason?: string;
                result: boolean;
            };
            response: void;
        };
        setSelfInfo: { request: { data: Partial<Self> }; response: void };
        unreceiveEvent: { request: { event: Handle | Handle[] }; response: void };
        uploadCacheFile: {
            request: { file: string | Buffer<ArrayBufferLike> };
            response: string;
        };
    }
    Index

    Properties

    clearCache: { request: void; response: void }

    清空缓存目录

    delGroup: {
        request: { block?: boolean; dismiss?: boolean; id: string };
        response: void;
    }

    退群

    群ID

    是否禁止再次请求

    是群主时,是否解散群

    delGroupMember: {
        request: { block?: boolean; id: string; uid: string };
        response: void;
    }

    删除群成员

    群ID

    成员ID

    是否禁止再次请求

    delMsg: { request: { id: string }; response: void }

    撤回消息

    消息ID

    delUser: { request: { block?: boolean; id: string }; response: void }

    删好友

    好友ID

    是否禁止再次请求

    getChatHistory: {
        request: {
            count?: number;
            id: string;
            newer?: boolean;
            type: "message" | "user" | "group";
        };
        response: Message[];
    }

    获取消息记录

    ID类型 message: 从该消息开始 user: 从该用户最新消息 group: 从该群最新消息

    ID

    往前获取消息数量

    往后获取新消息

    getFile: { request: { id: string }; response: BinaryFile | URLFile }

    获取文件

    文件ID

    getGroupArray: { request: void | { refresh?: boolean }; response: Group[] }

    获取群信息列表

    getGroupInfo: { request: { id: string; refresh?: boolean }; response: Group }

    获取群信息

    群ID

    是否刷新

    getGroupList: { request: void | { refresh?: boolean }; response: string[] }

    获取群ID列表

    getGroupMemberArray: {
        request: { id: string; refresh?: boolean };
        response: GroupMember[];
    }

    获取群信息列表

    getGroupMemberInfo: {
        request: { id: string; refresh?: boolean; uid: string };
        response: GroupMember;
    }

    获取群成员信息

    群ID

    用户ID

    是否刷新

    getGroupMemberList: {
        request: { id: string; refresh?: boolean };
        response: string[];
    }

    获取群ID列表

    getMsg: { request: { id: string }; response: Message }

    获取消息

    消息ID

    消息

    getRequestArray: {
        request:
            | void
            | { count?: number; scene?: "user_add"
            | "group_add"
            | "group_invite" };
        response: Request[];
    }

    获取请求列表

    请求场景,默认全部

    请求数量

    getSelfInfo: { request: void | { refresh?: boolean }; response: Self }

    获取自己信息

    是否刷新

    getUserArray: { request: void | { refresh?: boolean }; response: User[] }

    获取用户信息列表

    getUserInfo: { request: { id: string; refresh?: boolean }; response: User }

    获取用户信息

    用户ID

    是否刷新

    getUserList: { request: void | { refresh?: boolean }; response: string[] }

    获取用户ID列表

    getVersion: {
        request: void;
        response: {
            impl: { id: string; name: string; version: string };
            proto: { id: string; name: string; version: string };
        };
    }

    获取版本信息

    receiveEvent: { request: { event: Handle | Handle[] }; response: void }

    接收事件

    sendMsg: {
        request: { data: Message; id: string; scene: "user" | "group" };
        response: RSendMsg;
    }

    发送消息

    发送场景

    发送对象ID

    消息段

    sendMsgForward: {
        request: { id: string; mid: string; scene: "user" | "group" };
        response: RSendMsg;
    }

    转发消息

    转发场景

    发送对象ID

    被转发消息ID

    sendMultiMsg: {
        request: { data: Forward[]; id: string; scene: "user" | "group" };
        response: RSendMsg[];
    }

    发送多条消息(合并转发)

    发送场景

    发送对象ID

    消息数组

    setGroupMemberInfo: {
        request: { data: Partial<GroupMember>; id: string; uid: string };
        response: void;
    }

    设置群成员信息

    群ID

    成员ID

    信息对象

    setInfo: {
        request: {
            data: Partial<User | Group>;
            id: string;
            scene: "user" | "group";
        };
        response: void;
    }

    设置信息

    信息场景

    信息ID

    信息对象

    setRequest: {
        request: {
            block?: boolean;
            id: string;
            reason?: string;
            result: boolean;
        };
        response: void;
    }

    处理请求

    请求ID

    是否同意

    处理原因

    是否禁止再次请求

    setSelfInfo: { request: { data: Partial<Self> }; response: void }

    设置自己信息

    信息对象

    成功无返回,失败报错

    unreceiveEvent: { request: { event: Handle | Handle[] }; response: void }

    取消接收事件

    uploadCacheFile: {
        request: { file: string | Buffer<ArrayBufferLike> };
        response: string;
    }

    上传文件到缓存目录

    文件路径/二进制

    文件ID