Class FishPi

constructor

• new FishPi(token?: string): FishPi

  构造一个 API 请求对象

  Parameters

  • token: string = ''

    接口 API Key，没有可以传空

  Returns FishPi

Readonlyaccount

Readonlyarticle

Readonlybreezemoon

Readonlychat

Readonlychatroom

Readonlycomment

Readonlyemoji

Readonlynotice

authVerify

• authVerify(query: Record<string, string>): Promise<IUserLite | undefined>

  校验登录回调

  Parameters

  • query: Record<string, string>

    验证返回的地址 QueryString 参数

  Returns Promise<IUserLite | undefined>

  验证成功则返回用户简略信息，否则返回 undefined

generateAuthURL

• generateAuthURL(redirect: string): string

  生成登录认证地址

  Parameters

  • redirect: string

    登录成功后跳转的地址

  Returns string

log

• log(page: { page?: number; pageSize?: number }): Promise<ILog[]>

  获取操作日志

  Parameters

  • page: { page?: number; pageSize?: number }

    页码

  Returns Promise<ILog[]>

login

• login(data: Account): Promise<string>

  登录账号返回 API Key

  Parameters

  • data: Account

    用户账密

  Returns Promise<string>

names

• names(name: string): Promise<IAtUser[]>

  用户名联想，通常用于 @ 列表

  Parameters

  • name: string

  Returns Promise<IAtUser[]>

preRegister

• preRegister(data: PreRegisterInfo): Promise<void>

  预注册账号

  Parameters

  • data: PreRegisterInfo

    用户信息

  Returns Promise<void>

  void

recentRegister

• recentRegister(): Promise<{ userName: string; userNickname: string }[]>

  获取最近注册的20个用户

  Returns Promise<{ userName: string; userNickname: string }[]>

register

• register(data: RegisterInfo): Promise<void>

  注册账号

  Parameters

  • data: RegisterInfo

    注册信息

  Returns Promise<void>

  void

report

• report(data: IReport): Promise<void>

  举报

  Parameters

  • data: IReport

    举报信息

  Returns Promise<void>

setDomain

• setDomain(domain: string): Promise<void>

  设置 API 域名

  Parameters

  • domain: string

    API 域名

  Returns Promise<void>

  void

setToken

• setToken(apiKey: string): Promise<void>

  设置请求 Token

  Parameters

  • apiKey: string

    接口 API Key

  Returns Promise<void>

  void

upload

• upload(files: (string | File)[]): Promise<IUploadInfo>

  上传文件

  Parameters

  • files: (string | File)[]

    要上传的文件，如果是在 Node 使用，则传入文件路径数组，若是在浏览器使用，则传入文件对象数组。

  Returns Promise<IUploadInfo>

user

• user(username: string): Promise<UserInfo | undefined>

  查询指定用户信息

  Parameters

  • username: string

    用户名

  Returns Promise<UserInfo | undefined>

userByoId

• userByoId(oId: string): Promise<IUserLite | undefined>

  查询指定用户 oId 的用户信息

  Parameters

  • oId: string

  Returns Promise<IUserLite | undefined>

userPoints

• userPoints(username: string): Promise<number>

  查询指定用户积分

  Parameters

  • username: string

    用户名

  Returns Promise<number>

  用户积分

verify

• verify(code: string): Promise<number>

  验证手机验证码

  Parameters

  • code: string

    验证码

  Returns Promise<number>

  验证状态

vipInfo

• vipInfo(userId: string): Promise<UserVIP>

  获取用户 VIP 信息

  Parameters

  • userId: string

    用户 oId

  Returns Promise<UserVIP>