Class default

constructor

• new default(impl: Project): default

  Parameters

  • impl: Project

  Returns default

impl

_convertGroupInfo

• _convertGroupInfo(res: GroupInfo): Group

  Parameters

  • res: GroupInfo

  Returns Group

_convertGroupMemberInfo

• _convertGroupMemberInfo(res: MemberInfo): GroupMember

  Parameters

  • res: MemberInfo

  Returns GroupMember

_convertUserInfo

• _convertUserInfo(res: { nickname: string; user_id: number }): User

  Parameters

  • res: { nickname: string; user_id: number }

  Returns User

_getReactionType

• _getReactionType(
      data:
          | {
              eid: string;
              etype?: number;
              id: string;
              seq?: number;
              type: "message"
              | "user"
              | "group";
          }
          | {
              eid: string;
              etype?: number;
              id: string;
              seq?: number;
              type: "message"
              | "user"
              | "group";
          },
  ): Promise<void>

  Parameters

  • data:
        | {
            eid: string;
            etype?: number;
            id: string;
            seq?: number;
            type: "message"
            | "user"
            | "group";
        }
        | {
            eid: string;
            etype?: number;
            id: string;
            seq?: number;
            type: "message"
            | "user"
            | "group";
        }

  Returns Promise<void>

_sendFile

• _sendFile(
      __namedParameters: { data: IFile; id: string; scene: "user" | "group" },
  ): Promise<string>

  Parameters

  • __namedParameters: { data: IFile; id: string; scene: "user" | "group" }

  Returns Promise<string>

addGroupEssence

• addGroupEssence(
      __namedParameters: { id: string; rand?: number; seq?: number },
  ): Promise<void>

  若有 seq，则id为群ID，否则为消息ID

  Parameters

  • __namedParameters: { id: string; rand?: number; seq?: number }

  Returns Promise<void>

addGroupFSDir

• addGroupFSDir(
      __namedParameters: { id: string; name: string },
  ): Promise<GfsDirStat>

  Parameters

  • __namedParameters: { id: string; name: string }

  Returns Promise<GfsDirStat>

addUserBack

• addUserBack(
      __namedParameters: { id: string; remark: string; seq: number },
  ): Promise<void>

  Parameters

  • __namedParameters: { id: string; remark: string; seq: number }

  Returns Promise<void>

addUserClass

• addUserClass(__namedParameters: { name: string }): Promise<void>

  Parameters

  • __namedParameters: { name: string }

  Returns Promise<void>

clearCache

• clearCache(): void

  清空缓存目录

  Returns void

delGroup

• delGroup(
      __namedParameters: { block?: boolean; dismiss?: boolean; id: string },
  ): Promise<void>

  退群

  Parameters

  • __namedParameters: { block?: boolean; dismiss?: boolean; id: string }

  Returns Promise<void>

delGroupAnnounce

• delGroupAnnounce(): void

  发送群公告

  Returns void

delGroupEssence

• delGroupEssence(
      __namedParameters: { id: string; rand?: number; seq?: number },
  ): Promise<void>

  Parameters

  • __namedParameters: { id: string; rand?: number; seq?: number }

  Returns Promise<void>

delGroupFSFile

• delGroupFSFile(__namedParameters: { fid: string; id: string }): Promise<void>

  Parameters

  • __namedParameters: { fid: string; id: string }

  Returns Promise<void>

delGroupMember

• delGroupMember(
      __namedParameters: { block?: boolean; id: string; uid: string },
  ): Promise<void>

  删除群成员

  Parameters

  • __namedParameters: { block?: boolean; id: string; uid: string }

  Returns Promise<void>

delMsg

• delMsg(id: { id: string }): Promise<void>

  撤回消息

  Parameters

  • id: { id: string }

    消息ID

  Returns Promise<void>

delReaction

• delReaction(
      data: {
          eid: string;
          etype?: number;
          id: string;
          seq?: number;
          type: "message" | "user" | "group";
      },
  ): Promise<any>

  Parameters

  • data: {
        eid: string;
        etype?: number;
        id: string;
        seq?: number;
        type: "message" | "user" | "group";
    }

  Returns Promise<any>

delRoamingStamp

• delRoamingStamp(__namedParameters: { id: string | string[] }): Promise<void>

  Parameters

  • __namedParameters: { id: string | string[] }

  Returns Promise<void>

delUser

• delUser(__namedParameters: { block?: boolean; id: string }): Promise<void>

  删好友

  Parameters

  • __namedParameters: { block?: boolean; id: string }

  Returns Promise<void>

delUserClass

• delUserClass(__namedParameters: { name: string | number }): Promise<void>

  Parameters

  • __namedParameters: { name: string | number }

  Returns Promise<void>

forwardGroupFSFile

• forwardGroupFSFile(
      __namedParameters: {
          fid: unknown;
          id: string;
          name?: string;
          pid?: string;
      },
  ): Promise<GfsFileStat>

  Parameters

  • __namedParameters: { fid: unknown; id: string; name?: string; pid?: string }

  Returns Promise<GfsFileStat>

getChatHistory

• getChatHistory(
      __namedParameters: {
          count?: number;
          id: string;
          newer?: boolean;
          type: "message" | "user" | "group";
      },
  ): Promise<(UserMessage | GroupMessage)[]>

  获取消息记录

  Parameters

  • __namedParameters: {
        count?: number;
        id: string;
        newer?: boolean;
        type: "message" | "user" | "group";
    }

  Returns Promise<(UserMessage | GroupMessage)[]>

getFile

• getFile(id: { id: string }): URLFile

  获取文件

  Parameters

  • id: { id: string }

    文件ID

  Returns URLFile

getForwardMsg

• getForwardMsg(id: { id: string }): Promise<Forward[]>

  获取合并转发消息

  Parameters

  • id: { id: string }

    转发ID

  Returns Promise<Forward[]>

getGroupAnnounceList

• getGroupAnnounceList(): never[]

  获取群公告列表

  Returns never[]

getGroupArray

• getGroupArray(
      __namedParameters?: void | { refresh?: boolean },
  ): Promise<Group[]>

  获取群信息列表

  Parameters

  • __namedParameters: void | { refresh?: boolean } = {}

  Returns Promise<Group[]>

getGroupAtAllRemainder

• getGroupAtAllRemainder(__namedParameters: { id: string }): Promise<number>

  Parameters

  • __namedParameters: { id: string }

  Returns Promise<number>

getGroupFSDf

• getGroupFSDf(
      __namedParameters: { id: string },
  ): Promise<
      { free: number; total: number; used: number } & {
          file_count: number;
          max_file_count: number;
      },
  >

  Parameters

  • __namedParameters: { id: string }

  Returns Promise<
      { free: number; total: number; used: number } & {
          file_count: number;
          max_file_count: number;
      },
  >

getGroupFSDir

• getGroupFSDir(
      __namedParameters: {
          id: string;
          limit?: number;
          pid?: string;
          start?: number;
      },
  ): Promise<(GfsFileStat | GfsDirStat)[]>

  Parameters

  • __namedParameters: { id: string; limit?: number; pid?: string; start?: number }

  Returns Promise<(GfsFileStat | GfsDirStat)[]>

getGroupFSFile

• getGroupFSFile(
      __namedParameters: { fid: string; id: string },
  ): Promise<Omit<FileElem, "type"> & { url: string }>

  Parameters

  • __namedParameters: { fid: string; id: string }

  Returns Promise<Omit<FileElem, "type"> & { url: string }>

getGroupFSStat

• getGroupFSStat(
      __namedParameters: { fid: string; id: string },
  ): Promise<GfsFileStat | GfsDirStat>

  Parameters

  • __namedParameters: { fid: string; id: string }

  Returns Promise<GfsFileStat | GfsDirStat>

getGroupInfo

• getGroupInfo(
      __namedParameters: { id: string; refresh?: boolean },
  ): Promise<Group>

  获取群信息

  Parameters

  • __namedParameters: { id: string; refresh?: boolean }

  Returns Promise<Group>

getGroupList

• getGroupList(
      __namedParameters?: void | { refresh?: boolean },
  ): Promise<string[]>

  获取群ID列表

  Parameters

  • __namedParameters: void | { refresh?: boolean } = {}

  Returns Promise<string[]>

getGroupMemberArray

• getGroupMemberArray(
      __namedParameters: { id: string; refresh?: boolean },
  ): Promise<GroupMember[]>

  获取群信息列表

  Parameters

  • __namedParameters: { id: string; refresh?: boolean }

  Returns Promise<GroupMember[]>

getGroupMemberInfo

• getGroupMemberInfo(
      __namedParameters: { id: string; refresh?: boolean; uid: string },
  ): Promise<GroupMember>

  获取群成员信息

  Parameters

  • __namedParameters: { id: string; refresh?: boolean; uid: string }

  Returns Promise<GroupMember>

getGroupMemberList

• getGroupMemberList(
      __namedParameters: { id: string; refresh?: boolean },
  ): Promise<string[]>

  获取群ID列表

  Parameters

  • __namedParameters: { id: string; refresh?: boolean }

  Returns Promise<string[]>

getImageOCR

• getImageOCR(__namedParameters: { image: Image }): Promise<OcrResult>

  Parameters

  • __namedParameters: { image: Image }

  Returns Promise<OcrResult>

getMsg

• getMsg(id: { id: string }): Promise<UserMessage | GroupMessage>

  获取消息

  Parameters

  • id: { id: string }

    消息ID

  Returns Promise<UserMessage | GroupMessage>

  消息

getRequestArray

• getRequestArray(
      __namedParameters?:
          | void
          | { count?: number; scene?: "user_add"
          | "group_add"
          | "group_invite" },
  ): Promise<Request[]>

  获取请求列表

  Parameters

  • __namedParameters: void | { count?: number; scene?: "user_add" | "group_add" | "group_invite" } = {}

  Returns Promise<Request[]>

getRoamingStamp

• getRoamingStamp(
      __namedParameters?: void | { refresh?: boolean },
  ): Promise<string[]>

  Parameters

  • __namedParameters: void | { refresh?: boolean } = {}

  Returns Promise<string[]>

getSelfCookie

• getSelfCookie(
      __namedParameters?: void | { domain?: string },
  ): string | { [k: string]: string }

  Parameters

  • __namedParameters: void | { domain?: string } = {}

  Returns string | { [k: string]: string }

getSelfCSRFToken

• getSelfCSRFToken(): number

  Returns number

getSelfInfo

• getSelfInfo(): { avatar: string; id: string; name: string }

  获取自己信息

  Returns { avatar: string; id: string; name: string }

getUserArray

• getUserArray(__namedParameters?: void | { refresh?: boolean }): Promise<User[]>

  获取用户信息列表

  Parameters

  • __namedParameters: void | { refresh?: boolean } = {}

  Returns Promise<User[]>

getUserInfo

• getUserInfo(__namedParameters: { id: string; refresh?: boolean }): Promise<User>

  获取用户信息

  Parameters

  • __namedParameters: { id: string; refresh?: boolean }

  Returns Promise<User>

getUserList

• getUserList(__namedParameters?: void | { refresh?: boolean }): Promise<string[]>

  获取用户ID列表

  Parameters

  • __namedParameters: void | { refresh?: boolean } = {}

  Returns Promise<string[]>

getVersion

• getVersion(): {
      impl: { id: string; name: string; version: string };
      proto: Apk;
  }

  获取版本信息

  Returns { impl: { id: string; name: string; version: string }; proto: Apk }

moveGroupFSFile

• moveGroupFSFile(
      __namedParameters: { fid: string; id: string; pid: string },
  ): Promise<void>

  Parameters

  • __namedParameters: { fid: string; id: string; pid: string }

  Returns Promise<void>

receiveEvent

• receiveEvent(
      __namedParameters: { event: Handle | Handle[] },
      client?: Client,
  ): void

  接收事件

  Parameters

  • __namedParameters: { event: Handle | Handle[] }
  • Optionalclient: Client

  Returns void

renameGroupFSFile

• renameGroupFSFile(
      __namedParameters: { fid: string; id: string; name: string },
  ): Promise<void>

  Parameters

  • __namedParameters: { fid: string; id: string; name: string }

  Returns Promise<void>

renameUserClass

• renameUserClass(
      __namedParameters: { name: string | number; new_name: string },
  ): Promise<void>

  Parameters

  • __namedParameters: { name: string | number; new_name: string }

  Returns Promise<void>

searchUserSameGroup

• searchUserSameGroup(__namedParameters: { id: string }): Promise<any>

  Parameters

  • __namedParameters: { id: string }

  Returns Promise<any>

sendGroupAnnounce

• sendGroupAnnounce(
      __namedParameters: { content: string; id: string; image?: IFile },
  ): Promise<void>

  发送群公告

  Parameters

  • __namedParameters: { content: string; id: string; image?: IFile }

  Returns Promise<void>

sendGroupSign

• sendGroupSign(__namedParameters: { id: string }): Promise<void>

  Parameters

  • __namedParameters: { id: string }

  Returns Promise<void>

sendGroupUserInvite

• sendGroupUserInvite(
      __namedParameters: { id: string; uid: string },
  ): Promise<void>

  Parameters

  • __namedParameters: { id: string; uid: string }

  Returns Promise<void>

sendMsg

• sendMsg(
      __namedParameters: {
          data: Message;
          id: string;
          scene: "user" | "group";
      },
  ): Promise<RSendMsg>

  发送消息

  Parameters

  • __namedParameters: { data: Message; id: string; scene: "user" | "group" }

  Returns Promise<RSendMsg>

sendMsgForward

• sendMsgForward(
      __namedParameters: { id: string; mid: string; scene: "user" | "group" },
  ): Promise<RSendMsg>

  转发消息

  Parameters

  • __namedParameters: { id: string; mid: string; scene: "user" | "group" }

  Returns Promise<RSendMsg>

sendMultiMsg

• sendMultiMsg(
      __namedParameters: {
          data: Forward[];
          id: string;
          scene: "user" | "group";
      },
  ): Promise<RSendMsg[]>

  发送多条消息（合并转发）

  Parameters

  • __namedParameters: { data: Forward[]; id: string; scene: "user" | "group" }

  Returns Promise<RSendMsg[]>

sendOidb

• sendOidb(args: unknown[]): any

  Parameters

  • args: unknown[]

  Returns any

sendOidbSvcTrpcTcp

• sendOidbSvcTrpcTcp(args: unknown[]): any

  Parameters

  • args: unknown[]

  Returns any

sendPacket

• sendPacket(args: unknown[]): any

  Parameters

  • args: unknown[]

  Returns any

sendPoke

• sendPoke(
      __namedParameters: { id: string; scene: "user" | "group"; tid: string },
  ): Promise<void>

  发送戳一戳

  Parameters

  • __namedParameters: { id: string; scene: "user" | "group"; tid: string }

  Returns Promise<void>

sendUni

• sendUni(args: unknown[]): any

  Parameters

  • args: unknown[]

  Returns any

sendUserLike

• sendUserLike(__namedParameters: { id: string; times: number }): Promise<void>

  Parameters

  • __namedParameters: { id: string; times: number }

  Returns Promise<void>

setGroupJoinType

• setGroupJoinType(
      __namedParameters: {
          answer?: string;
          id: string;
          question?: string;
          type: string;
      },
  ): Promise<void>

  Parameters

  • __namedParameters: { answer?: string; id: string; question?: string; type: string }

  Returns Promise<void>

setGroupMemberInfo

• setGroupMemberInfo(
      __namedParameters: {
          data: Partial<Contact.GroupMember>;
          id: string;
          uid: string;
      },
  ): Promise<void>

  设置群成员信息

  Parameters

  • __namedParameters: { data: Partial<Contact.GroupMember>; id: string; uid: string }

  Returns Promise<void>

setInfo

• setInfo(
      __namedParameters: {
          data: Partial<User | Group>;
          id: string;
          scene: "user" | "group";
      },
  ): Promise<void>

  设置信息

  Parameters

  • __namedParameters: { data: Partial<User | Group>; id: string; scene: "user" | "group" }

  Returns Promise<void>

setMessageRate

• setMessageRate(__namedParameters: { id: string; times: number }): any

  Parameters

  • __namedParameters: { id: string; times: number }

  Returns any

setReaction

• setReaction(
      data: {
          eid: string;
          etype?: number;
          id: string;
          seq?: number;
          type: "message" | "user" | "group";
      },
  ): Promise<any>

  Parameters

  • data: {
        eid: string;
        etype?: number;
        id: string;
        seq?: number;
        type: "message" | "user" | "group";
    }

  Returns Promise<any>

setReaded

• setReaded(
      __namedParameters: { id: string; seq?: number; time?: number },
  ): Promise<void>

  Parameters

  • __namedParameters: { id: string; seq?: number; time?: number }

  Returns Promise<void>

setRequest

• setRequest(
      __namedParameters: {
          block?: boolean;
          id: string;
          reason?: string;
          result: boolean;
      },
  ): Promise<void>

  处理请求

  Parameters

  • __namedParameters: { block?: boolean; id: string; reason?: string; result: boolean }

  Returns Promise<void>

setSelfInfo

• setSelfInfo(data: { data: Partial<Contact.Self> }): Promise<void>

  设置自己信息

  Parameters

  • data: { data: Partial<Contact.Self> }

    信息对象

  Returns Promise<void>

  成功无返回，失败报错

setUserClass

• setUserClass(
      __namedParameters: { id: string; name: string | number },
  ): Promise<void>

  Parameters

  • __namedParameters: { id: string; name: string | number }

  Returns Promise<void>

unreceiveEvent

• unreceiveEvent(
      __namedParameters: { event: Handle | Handle[] },
      client?: Client,
  ): void

  取消接收事件

  Parameters

  • __namedParameters: { event: Handle | Handle[] }
  • Optionalclient: Client

  Returns void

uploadCacheFile

• uploadCacheFile(): string

  上传文件到缓存目录

  Returns string

  文件ID

uploadGroupFSFile

• uploadGroupFSFile(
      __namedParameters: {
          file: string | Buffer<ArrayBufferLike>;
          id: string;
          name?: string;
          pid?: string;
      },
  ): Promise<GfsFileStat>

  Parameters

  • __namedParameters: {
        file: string | Buffer<ArrayBufferLike>;
        id: string;
        name?: string;
        pid?: string;
    }

  Returns Promise<GfsFileStat>

writeUni

• writeUni(args: unknown[]): any

  Parameters

  • args: unknown[]

  Returns any