Class default

constructor

• new default(impl: default): default

  Parameters

  • impl: default

  Returns default

cache

group_cache

group_member_cache

impl

user_cache

_convertGroupInfo

• _convertGroupInfo(res: Group): Group

  Parameters

  • res: Group

  Returns Group

_convertGroupMemberInfo

• _convertGroupMemberInfo(res: GroupMember): GroupMember

  Parameters

  • res: GroupMember

  Returns GroupMember

_convertUserInfo

• _convertUserInfo(res: User): User

  Parameters

  • res: User

  Returns User

_getFileUri

• _getFileUri(data: IFile): Promise<string>

  Parameters

  • data: IFile

  Returns Promise<string>

_sendFile

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

  Parameters

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

  Returns Promise<string>

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(__namedParameters: { gid: string; id: string }): Promise<void>

  发送群公告

  Parameters

  • __namedParameters: { gid: 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>

delUser

• delUser(): void

  删好友

  Returns void

getChatHistory

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

  获取消息记录

  Parameters

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

  Returns Promise<Message[]>

getFile

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

  获取文件

  Parameters

  • id: { id: string }

    文件ID

  Returns Promise<URLFile>

getForwardMsg

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

  获取合并转发消息

  Parameters

  • id: { id: string }

    转发ID

  Returns Promise<Forward[]>

getGroupAnnounceList

• getGroupAnnounceList(
      id: { id: string },
  ): Promise<
      {
          content: string;
          gid: string;
          id: string;
          image: URLFile;
          time: number;
          uid: string;
      }[],
  >

  获取群公告列表

  Parameters

  • id: { id: string }

    群ID

  Returns Promise<
      {
          content: string;
          gid: string;
          id: string;
          image: URLFile;
          time: number;
          uid: string;
      }[],
  >

getGroupArray

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

  获取群信息列表

  Parameters

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

  Returns Promise<Group[]>

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

getMsg

• getMsg(id: { id: string }): Promise<Message>

  获取消息

  Parameters

  • id: { id: string }

    消息ID

  Returns Promise<Message>

  消息

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

getSelfInfo

• getSelfInfo(refresh?: void | { refresh?: boolean }): Promise<Self>

  获取自己信息

  Parameters

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

    是否刷新

  Returns Promise<Self>

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(): Promise<
      {
          impl: { id: string; name: string; version: string };
          proto: { id: string; name: string; version: string };
      },
  >

  获取版本信息

  Returns Promise<
      {
          impl: { id: string; name: string; version: string };
          proto: { id: string; name: string; version: string };
      },
  >

receiveEvent

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

  接收事件

  Parameters

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

  Returns void

sendGroupAnnounce

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

  发送群公告

  Parameters

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

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

sendPoke

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

  发送戳一戳

  Parameters

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

  Returns Promise<void>

setGroupMemberInfo

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

  设置群成员信息

  Parameters

  • __namedParameters: { data: Partial<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>

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(): Promise<void>

  设置自己信息

  Returns Promise<void>

  成功无返回，失败报错

unreceiveEvent

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

  取消接收事件

  Parameters

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

  Returns void

uploadCacheFile

• uploadCacheFile(): string

  上传文件到缓存目录

  Returns string

  文件ID