node-karin 0.12.13 → 0.12.15

package/lib/adapter/onebot/11/index.d.ts

@@ -8,9 +8,7 @@ import { Scene, Contact, KarinElement, OB11EventAll, GroupInfo, NodeElement, Ess
  */
 export declare class AdapterOneBot11 implements KarinAdapter {
     #private;
-    /**
-     * - 重连次数 仅正向ws使用
-     */
+    /** 重连次数 仅正向ws使用 */
     index: number;
     socket: WebSocket;
     account: KarinAdapter['account'];
@@ -55,12 +53,12 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     getAvatarUrl(uid?: string, size?: number): string;
     /**
      * 获取群头像
-     * @param group_id - 群号
+     * @param groupId - 群号
      * @param size - 头像大小，默认`0`
      * @param history - 历史头像记录，默认`0`，若要获取历史群头像则填写1,2,3...
      * @returns - 群头像的url地址
      */
-    getGroupAvatarUrl(group_id: string, size?: number, history?: number): string;
+    getGroupAvatarUrl(groupId: string, size?: number, history?: number): string;
     /**
      * 发送消息
      *
@@ -91,15 +89,15 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     /**
      * 撤回消息
      * @param _contact - ob11无需提供contact参数
-     * @param message_id - 消息ID
+     * @param messageId - 消息ID
      */
-    RecallMessage(_contact: Contact, message_id: string): Promise<boolean>;
+    RecallMessage(_contact: Contact, messageId: string): Promise<boolean>;
     /**
      * 获取消息
      * @param contact - 联系人信息
-     * @param message_id - 消息ID
+     * @param messageId - 消息ID
      */
-    GetMessage(contact: Contact, message_id: string): Promise<{
+    GetMessage(contact: Contact, messageId: string): Promise<{
         time: number;
         message_id: string;
         message_seq: number;
@@ -119,7 +117,7 @@ export declare class AdapterOneBot11 implements KarinAdapter {
      * 获取msg_id获取历史消息
      * @description 此api各平台实现不同
      */
-    GetHistoryMessage(contact: Contact, start_message_id: string, count?: number): Promise<{
+    GetHistoryMessage(contact: Contact, startMessageId: string, count?: number): Promise<{
         time: number;
         message_id: string;
         message_seq: number;
@@ -138,60 +136,64 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     }[]>;
     /**
      * 发送好友赞
-     * @param target_uid_or_uin - 用户ID
-     * @param vote_count - 赞的次数，默认为`10`
+     * @param targetId - 用户ID
+     * @param voteCount - 赞的次数，默认为`10`
      */
-    VoteUser(target_uid_or_uin: string, vote_count?: number): Promise<boolean>;
+    VoteUser(targetId: string, voteCount?: number): Promise<boolean>;
     /**
      * 群组踢人
+     * @param groupId - 群号
+     * @param targetId - 用户ID
+     * @param rejectAddRequest - 是否拒绝此人的加群请求
+     * @param kickReason - 踢人理由
      */
-    KickMember(group_id: string, target_uid_or_uin: string, reject_add_request?: boolean, kick_reason?: string): Promise<boolean>;
+    KickMember(groupId: string, targetId: string, rejectAddRequest?: boolean, kickReason?: string): Promise<boolean>;
     /**
      * 禁言用户
-     * @param group_id - 群号
-     * @param target_uid_or_uin - 用户ID
+     * @param groupId - 群号
+     * @param targetId - 用户ID
      * @param duration - 禁言时长，单位秒，0 表示取消禁言
      */
-    BanMember(group_id: string, target_uid_or_uin: string, duration: number): Promise<boolean>;
+    BanMember(groupId: string, targetId: string, duration: number): Promise<boolean>;
     /**
      * 群组全员禁言
-     * @param group_id - 群号
-     * @param is_ban - 是否全员禁言
+     * @param groupId - 群号
+     * @param isBan - 是否全员禁言
      */
-    SetGroupWholeBan(group_id: string, is_ban?: boolean): Promise<boolean>;
+    SetGroupWholeBan(groupId: string, isBan?: boolean): Promise<boolean>;
     /**
      * 设置群管理员
-     * @param group_id - 群号
-     * @param target_uid_or_uin - 目标用户ID
-     * @param is_admin - 是否设置为管理员
+     * @param groupId - 群号
+     * @param targetId - 目标用户ID
+     * @param isAdmin - 是否设置为管理员
      */
-    SetGroupAdmin(group_id: string, target_uid_or_uin: string, is_admin: boolean): Promise<boolean>;
+    SetGroupAdmin(groupId: string, targetId: string, isAdmin: boolean): Promise<boolean>;
     /**
      * 修改群名片
-     * @param group_id - 群号
-     * @param target_uid_or_uin - 目标用户ID
+     * @param groupId - 群号
+     * @param targetId - 目标用户ID
      * @param card - 新名片
      */
-    ModifyMemberCard(group_id: string, target_uid_or_uin: string, card: string): Promise<boolean>;
+    ModifyMemberCard(groupId: string, targetId: string, card: string): Promise<boolean>;
     /**
      * 设置群名
-     * @param group_id - 群号
-     * @param group_name - 新群名
+     * @param groupId - 群号
+     * @param groupName - 新群名
      */
-    ModifyGroupName(group_id: string, group_name: string): Promise<boolean>;
+    ModifyGroupName(groupId: string, groupName: string): Promise<boolean>;
     /**
      * 退出群组
-     * @param group_id - 群号
-     * @param is_dismiss - 是否解散，如果登录号是群主，则仅在此项为 true 时能够解散
+     * @param groupId - 群号
+     * @param isDismiss - 是否解散，如果登录号是群主，则仅在此项为 true 时能够解散
      */
-    LeaveGroup(group_id: string, is_dismiss?: boolean): Promise<false | undefined>;
+    LeaveGroup(groupId: string, isDismiss?: boolean): Promise<false | undefined>;
     /**
      * 设置群专属头衔
-     * @param group_id - 群号
-     * @param target_uid_or_uin - 目标用户ID
+     * @param groupId - 群号
+     * @param targetId - 目标用户ID
      * @param special_title - 专属头衔
      */
-    SetGroupUniqueTitle(group_id: string, target_uid_or_uin: string, unique_title: string): Promise<false | undefined>;
+    SetGroupUniqueTitle(groupId: string, targetId: string, uniqueTitle: string): Promise<false | undefined>;
     /**
      * 获取登录号信息
      */
@@ -202,48 +204,28 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     }>;
     /**
      * 获取陌生人信息 不支持批量获取 只支持一个
-     * @param target_uid_or_uin - 目标用户ID
+     * @param targetId - 目标用户ID
      */
-    GetStrangerProfileCard(target_uid_or_uin: Array<string>): Promise<{
-        /**
-         * - 用户UID
-         */
+    GetStrangerProfileCard(targetId: Array<string>): Promise<{
+        /** 用户UID */
         uid: string;
-        /**
-       * - 用户UIN
-       */
+        /** 用户UIN */
         uin: string;
-        /**
-       * - qid
-       */
+        /** qid */
         qid: string;
-        /**
-       * - 名称
-       */
+        /** 名称 */
         nick: string;
-        /**
-       * - 备注
-       */
+        /** 备注 */
         remark: string;
-        /**
-       * - 用户等级
-       */
+        /** 用户等级 */
         level: number;
-        /**
-       * - 生日
-       */
+        /** 生日 */
         birthday: string;
-        /**
-       * - 登录天数
-       */
+        /** 登录天数 */
         login_day: number;
-        /**
-       * - 点赞数
-       */
+        /** 点赞数 */
         vote_cnt: number;
-        /**
-       * - 学校是否已核实
-       */
+        /** 学校是否已核实 */
         is_school_verified: undefined;
         /**
        * - 年龄
@@ -282,45 +264,25 @@ export declare class AdapterOneBot11 implements KarinAdapter {
      * 获取好友列表
      */
     GetFriendList(): Promise<{
-        /**
-         * - 用户UID
-         */
+        /** 用户UID */
         uid: string;
-        /**
-       * - 用户UIN
-       */
+        /** 用户UIN */
         uin: string;
-        /**
-       * - qid
-       */
+        /** qid */
         qid: string;
-        /**
-       * - 名称
-       */
+        /** 名称 */
         nick: string;
-        /**
-       * - 备注
-       */
+        /** 备注 */
         remark: string;
-        /**
-       * - 用户等级
-       */
+        /** 用户等级 */
         level: number;
-        /**
-       * - 生日
-       */
+        /** 生日 */
         birthday: string;
-        /**
-       * - 登录天数
-       */
+        /** 登录天数 */
         login_day: number;
-        /**
-       * - 点赞数
-       */
+        /** 点赞数 */
         vote_cnt: number;
-        /**
-       * - 学校是否已核实
-       */
+        /** 学校是否已核实 */
         is_school_verified: undefined;
         /**
        * - 年龄
@@ -357,10 +319,10 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     }[]>;
     /**
      * 获取群信息
-     * @param group_id - 群号
-     * @param no_cache - 是否不使用缓存
+     * @param _groupId - 群号
+     * @param noCache - 是否不使用缓存
      */
-    GetGroupInfo(group_id: string, no_cache?: boolean): Promise<GroupInfo>;
+    GetGroupInfo(_groupId: string, noCache?: boolean): Promise<GroupInfo>;
     /**
      * 获取群列表
      */
@@ -376,11 +338,11 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     }[]>;
     /**
      * 获取群成员信息
-     * @param group_id - 群号
-     * @param target_uid_or_uin - 目标用户ID
+     * @param groupId - 群号
+     * @param targetId - 目标用户ID
      * @param refresh - 是否刷新缓存，默认为 false
      */
-    GetGroupMemberInfo(group_id: string, target_uid_or_uin: string, refresh?: boolean): Promise<{
+    GetGroupMemberInfo(groupId: string, targetId: string, refresh?: boolean): Promise<{
         uid: string;
         uin: string;
         nick: string;
@@ -400,10 +362,10 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     }>;
     /**
      * 获取群成员列表
-     * @param group_id - 群号
+     * @param groupId - 群号
      * @param refresh - 是否刷新缓存，默认为 false
      */
-    GetGroupMemberList(group_id: string, refresh?: boolean): Promise<{
+    GetGroupMemberList(groupId: string, refresh?: boolean): Promise<{
         uid: string;
         uin: string;
         nick: string;
@@ -424,14 +386,14 @@ export declare class AdapterOneBot11 implements KarinAdapter {
     /**
      * 获取群荣誉信息
      */
-    GetGroupHonor(group_id: string, refresh?: boolean): Promise<GroupHonorInfo[]>;
+    GetGroupHonor(groupId: string, refresh?: boolean): Promise<GroupHonorInfo[]>;
     /**
      * 对消息进行表情回应
      * @param contact - 联系人信息
-     * @param message_id - 消息ID
-     * @param face_id - 表情ID
+     * @param messageId - 消息ID
+     * @param faceId - 表情ID
      */
-    ReactMessageWithEmoji(contact: Contact, message_id: string, face_id: number, is_set?: boolean): Promise<boolean>;
+    ReactMessageWithEmoji(contact: Contact, messageId: string, faceId: number, isSet?: boolean): Promise<boolean>;
     /**
      * 获取版本信息
      */
@@ -441,42 +403,42 @@ export declare class AdapterOneBot11 implements KarinAdapter {
         version: string;
         protocol: string;
     }>;
-    DownloadForwardMessage(res_id: string): Promise<any>;
+    DownloadForwardMessage(resId: string): Promise<any>;
     /**
      * 精华消息
      */
-    GetEssenceMessageList(group_id: string, page: number, page_size: number): Promise<EssenceMessageBody[]>;
+    GetEssenceMessageList(groupId: string, page: number, pageSize: number): Promise<EssenceMessageBody[]>;
     /**
      * 上传群文件
-     * @param group_id - 群号
+     * @param groupId - 群号
      * @param file - 本地文件绝对路径
      * @param name - 文件名称 必须提供
      * @param folder - 父目录ID 不提供则上传到根目录
      */
-    UploadGroupFile(group_id: string, file: string, name: string, folder?: string): Promise<boolean>;
+    UploadGroupFile(groupId: string, file: string, name: string, folder?: string): Promise<boolean>;
     /**
      * 上传私聊文件
-     * @param user_id - 用户ID
+     * @param userId - 用户ID
      * @param file - 本地文件绝对路径
      * @param name - 文件名称 必须提供
      */
-    UploadPrivateFile(user_id: string, file: string, name: string): Promise<boolean>;
+    UploadPrivateFile(userId: string, file: string, name: string): Promise<boolean>;
     /**
      * 设置精华消息
-     * @param _group_id - 群号
-     * @param message_id - 消息ID
+     * @param _groupId - 群号
+     * @param messageId - 消息ID
      */
-    SetEssenceMessage(_group_id: string, message_id: string): Promise<boolean>;
+    SetEssenceMessage(_groupId: string, messageId: string): Promise<boolean>;
     /**
      * 移除精华消息
-     * @param _group_id - 群号
-     * @param message_id - 消息ID
-     */
-    DeleteEssenceMessage(_group_id: string, message_id: string): Promise<boolean>;
-    PokeMember(group_id: string, target_uid_or_uin: string): Promise<void>;
-    SetFriendApplyResult(request_id: string, is_approve: boolean, remark?: string): Promise<boolean>;
-    SetGroupApplyResult(request_id: string, is_approve: boolean, deny_reason?: string): Promise<boolean>;
-    SetInvitedJoinGroupResult(request_id: string, is_approve: boolean, deny_reason?: string): Promise<boolean>;
+     * @param _groupId - 群号
+     * @param messageId - 消息ID
+     */
+    DeleteEssenceMessage(_groupId: string, messageId: string): Promise<boolean>;
+    PokeMember(groupId: string, targetId: string): Promise<void>;
+    SetFriendApplyResult(requestId: string, isApprove: boolean, remark?: string): Promise<boolean>;
+    SetGroupApplyResult(requestId: string, isApprove: boolean, denyReason?: string): Promise<boolean>;
+    SetInvitedJoinGroupResult(requestId: string, isApprove: boolean, denyReason?: string): Promise<boolean>;
     DownloadFile(): Promise<any>;
     CreateFolder(): Promise<any>;
     RenameFolder(): Promise<any>;