@kaguyajs/trss-yunzai-types
    Preparing search index...

    Interface User

    用户

    interface User {
        c: icqq.Client;
        getInfo: () => Promise<FriendInfo | MemberInfo>;
        gid?: string | number;
        uid: string | number;
        get "[unscopables]"(): { c: boolean };
        get client(): icqq.Client;
        get dm(): boolean;
        get target(): string | number;
        get user_id(): string | number;
        _preprocess(content: Sendable, source?: Quotable): Promise<Converter>;
        _sendMsg(
            proto3: Encodable,
            brief: string,
            file?: boolean,
        ): Promise<icqq.MessageRet>;
        addFriendBack(seq: number, remark?: string): Promise<boolean>;
        asFriend(strict?: boolean): Friend;
        asMember(gid: string | number, strict?: boolean): Member;
        getAddFriendSetting(): Promise<number>;
        getAvatarUrl(size?: 0 | 40 | 100 | 140): string;
        getChatHistory(time?: number, cnt?: number): Promise<PrivateMessage[]>;
        getFileInfo(
            fid: string,
        ): Promise<Omit<FileElem, "type"> & Record<"url", string>>;
        getFileUrl(fid: string): Promise<string>;
        getForwardMsg(
            resid: string,
            fileName?: string,
            nt?: boolean,
        ): Promise<ForwardMessage[]>;
        getSimpleInfo(): Promise<
            {
                age: number;
                area: string;
                nickname: string;
                sex: Gender;
                user_id: string
                | number;
            },
        >;
        getVideoUrl(
            fid: string,
            md5: string | Buffer<ArrayBufferLike>,
        ): Promise<string>;
        makeForwardMsg(
            msglist: Forwardable | Forwardable[],
            nt?: boolean,
        ): Promise<JsonElem>;
        markRead(time?: number): Promise<void>;
        recallMsg(msg: PrivateMessage): Promise<boolean>;
        recallMsg(msgid: string): Promise<boolean>;
        recallMsg(seq: number, rand: number, time: number): Promise<boolean>;
        recallMsg(param: number, rand: number, time: number): Promise<boolean>;
        recallMsg(message_id: string): Promise<boolean>;
        recallMsg(message: PrivateMessage): Promise<boolean>;
        sendMsg(content: Sendable, source?: Quotable): Promise<icqq.MessageRet>;
        setFriendReq(
            seq: number,
            yes?: boolean,
            remark?: string,
            block?: boolean,
        ): Promise<boolean>;
        setGroupInvite(
            gid: string | number,
            seq: number,
            yes?: boolean,
            block?: boolean,
        ): Promise<boolean>;
        setGroupReq(
            gid: string | number,
            seq: number,
            yes?: boolean,
            reason?: string,
            block?: boolean,
        ): Promise<boolean>;
        shareMusic(platform: MusicPlatform, id: string): Promise<void>;
        shareUrl(content: ShareContent, config?: ShareConfig): Promise<void>;
        thumbUp(times?: number): Promise<boolean>;
        uploadImages(imgs: Image[] | ImageElem[]): Promise<PromiseRejectedResult[]>;
        uploadPtt(
            elem: PttElem,
            transcoding?: boolean,
            brief?: string,
        ): Promise<PttElem>;
        uploadVideo(elem: VideoElem): Promise<VideoElem>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    c getInfo gid? uid

    Accessors

    [unscopables] client dm target user_id

    Methods

    _preprocess _sendMsg addFriendBack asFriend asMember getAddFriendSetting getAvatarUrl getChatHistory getFileInfo getFileUrl getForwardMsg getSimpleInfo getVideoUrl makeForwardMsg markRead recallMsg sendMsg setFriendReq setGroupInvite setGroupReq shareMusic shareUrl thumbUp uploadImages uploadPtt uploadVideo

    Properties

    c: icqq.Client
    getInfo: () => Promise<FriendInfo | MemberInfo>

    获取用户信息

    gid?: string | number

    对方群号

    uid: string | number

    对方QQ号

    Accessors

    • get "[unscopables]"(): { c: boolean }

      Returns { c: boolean }

    • get target(): string | number

      Returns string | number

    • get user_id(): string | number

      对方QQ号

      Returns string | number

    Methods

    Protected_preprocess

    Protected_sendMsg

    • _sendMsg(
          proto3: Encodable,
          brief: string,
          file?: boolean,
      ): Promise<icqq.MessageRet>

      Parameters

      • proto3: Encodable
      • brief: string
      • Optionalfile: boolean

      Returns Promise<icqq.MessageRet>

    • 回添双向好友

      Parameters

      • seq: number

        申请消息序号

      • Optionalremark: string

        好友备注

      Returns Promise<boolean>

    • 返回作为好友的实例

      Parameters

      • Optionalstrict: boolean

      Returns Friend

    • 返回作为某群群员的实例

      Parameters

      • gid: string | number
      • Optionalstrict: boolean

      Returns Member

    • Returns Promise<number>

    • 获取头像url

      Parameters

      • Optionalsize: 0 | 40 | 100 | 140

        头像大小，默认0

      Returns string

      头像的url地址

    • 获取time往前的cnt条聊天记录

      Parameters

      • Optionaltime: number

        默认当前时间，为时间戳的分钟数（Date.now() / 1000）

      • Optionalcnt: number

        聊天记录条数，默认20，超过20按20处理

      Returns Promise<PrivateMessage[]>

      私聊消息列表，服务器记录不足cnt条则返回能获取到的最多消息记录

    • 获取文件信息

      Parameters

      • fid: string

        文件id

      Returns Promise<Omit<FileElem, "type"> & Record<"url", string>>

    • 获取离线文件下载地址

      Parameters

      • fid: string

        文件id

      Returns Promise<string>

    • 下载并解析合并转发

      Parameters

      • resid: string
      • OptionalfileName: string
      • Optionalnt: boolean

      Returns Promise<ForwardMessage[]>

    • 查看资料

      Returns Promise<
          {
              age: number;
              area: string;
              nickname: string;
              sex: Gender;
              user_id: string
              | number;
          },
      >

    • 获取视频下载地址

      Parameters

      • fid: string
      • md5: string | Buffer<ArrayBufferLike>

      Returns Promise<string>

    • 制作一条合并转发消息以备发送（制作一次可以到处发） 需要注意的是，好友图片和群图片的内部格式不一样，对着群制作的转发消息中的图片，发给好友可能会裂图，反过来也一样 支持4层套娃转发（PC仅显示3层）

      Parameters

      Returns Promise<JsonElem>

    • 标记time之前为已读

      Parameters

      • Optionaltime: number

        默认当前时间，为时间戳的分钟数（Date.now() / 1000）

      Returns Promise<void>

    • 撤回消息

      Parameters

      Returns Promise<boolean>

    • Parameters

      • msgid: string

      Returns Promise<boolean>

    • Parameters

      • seq: number
      • rand: number
      • time: number

      Returns Promise<boolean>

    • 撤回消息，cqhttp方法用

      Parameters

      • param: number
      • rand: number
      • time: number

      Returns Promise<boolean>

    • 撤回消息

      Parameters

      • message_id: string

        消息id

      Returns Promise<boolean>

    • 撤回消息

      Parameters

      Returns Promise<boolean>

    • 处理好友申请

      Parameters

      • seq: number

        申请消息序号

      • Optionalyes: boolean

        是否同意

      • Optionalremark: string

        好友备注

      • Optionalblock: boolean

        是否屏蔽来自此用户的申请

      Returns Promise<boolean>

    • 处理群邀请

      Parameters

      • gid: string | number

        群号

      • seq: number

        申请消息序号

      • Optionalyes: boolean

        是否同意

      • Optionalblock: boolean

        是否屏蔽来自此群的邀请

      Returns Promise<boolean>

    • 处理入群申请

      Parameters

      • gid: string | number

        群号

      • seq: number

        申请消息序号

      • Optionalyes: boolean

        是否同意

      • Optionalreason: string

        若拒绝，拒绝的原因

      • Optionalblock: boolean

        是否屏蔽来自此用户的申请

      Returns Promise<boolean>

    • 点赞，支持陌生人点赞

      Parameters

      • Optionaltimes: number

        点赞次数，默认1次

      Returns Promise<boolean>

    • 上传一批图片以备发送(无数量限制)，理论上传一次所有群和好友都能发

      Parameters

      Returns Promise<PromiseRejectedResult[]>

    • 上传一个语音以备发送(理论上传一次所有群和好友都能发)

      Parameters

      • elem: PttElem
      • Optionaltranscoding: boolean
      • Optionalbrief: string

      Returns Promise<PttElem>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods