Class default

constructor

• new default(impl: default): default

  Parameters

  • impl: default

  Returns default

impl

_getInfo

• _getInfo(__namedParameters: { id: string; scene: "user" | "group" }): Self

  Parameters

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

  Returns Self

clearCache

• clearCache(): Promise<void>

  清空缓存目录

  Returns Promise<void>

delGroup

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

  退群

  Parameters

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

  Returns void

delGroupMember

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

  删除群成员

  Parameters

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

  Returns void

delMsg

• delMsg(id: { id: string }): void

  撤回消息

  Parameters

  • id: { id: string }

    消息ID

  Returns void

delUser

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

  删好友

  Parameters

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

  Returns void

getChatHistory

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

  获取消息记录

  Parameters

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

  Returns Message[]

getFile

• getFile(id: { id: string }): Promise<BinaryFile>

  获取文件

  Parameters

  • id: { id: string }

    文件ID

  Returns Promise<BinaryFile>

getGroupArray

• getGroupArray(): Group[]

  获取群信息列表

  Returns Group[]

getGroupInfo

• getGroupInfo(__namedParameters: { id: string; refresh?: boolean }): Group

  获取群信息

  Parameters

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

  Returns Group

getGroupList

• getGroupList(): string[]

  获取群ID列表

  Returns string[]

getGroupMemberArray

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

  获取群信息列表

  Parameters

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

  Returns GroupMember[]

getGroupMemberInfo

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

  获取群成员信息

  Parameters

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

  Returns GroupMember

getGroupMemberList

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

  获取群ID列表

  Parameters

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

  Returns string[]

getMsg

• getMsg(id: { id: string }): Message

  获取消息

  Parameters

  • id: { id: string }

    消息ID

  Returns Message

  消息

getRequestArray

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

  获取请求列表

  Parameters

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

  Returns Request[]

getSelfInfo

• getSelfInfo(): Self

  获取自己信息

  Returns Self

getUserArray

• getUserArray(): Self[]

  获取用户信息列表

  Returns Self[]

getUserInfo

• getUserInfo(__namedParameters: { id: string; refresh?: boolean }): Self

  获取用户信息

  Parameters

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

  Returns Self

getUserList

• getUserList(): string[]

  获取用户ID列表

  Returns string[]

getVersion

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

  获取版本信息

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

receiveEvent

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

  接收事件

  Parameters

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

  Returns 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[]>

setGroupMemberInfo

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

  设置群成员信息

  Parameters

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

  Returns void

setInfo

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

  设置信息

  Parameters

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

  Returns 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<Self> }): void

  设置自己信息

  Parameters

  • data: { data: Partial<Self> }

    信息对象

  Returns void

  成功无返回，失败报错

unreceiveEvent

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

  取消接收事件

  Parameters

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

  Returns void

uploadCacheFile

• uploadCacheFile(
      file: { file: string | Buffer<ArrayBufferLike> },
  ): Promise<string>

  上传文件到缓存目录

  Parameters

  • file: { file: string | Buffer<ArrayBufferLike> }

    文件路径/二进制

  Returns Promise<string>

  文件ID