Class JikeClient

Hierarchy

Constructors

constructor

Properties

prefixed

Accessors

accessToken apiClient config refreshToken

Methods

addListener createPost emit eventNames getPost getSelf getUser listenerCount listeners loginWithPassword loginWithSmsCode off on once queryFollowingUpdates queryNotifications removeAllListeners removeListener renewToken sendSmsCode serialize toJSON deserialize fromJSON

Constructors

constructor

  • new JikeClient(
        __namedParameters: Partial<ApiConfigResolved> & Pick<
            ApiConfigResolved,
            | "endpointId"
            | "endpointUrl"
            | "bundleId"
            | "appVersion"
            | "buildNo"
            | "userAgent",
        > & { refreshToken?: string },
    ): JikeClient

    Parameters

    • __namedParameters: Partial<ApiConfigResolved> & Pick<
          ApiConfigResolved,
          | "endpointId"
          | "endpointUrl"
          | "bundleId"
          | "appVersion"
          | "buildNo"
          | "userAgent",
      > & { refreshToken?: string }

    Returns JikeClient

Properties

Staticprefixed

prefixed: string | boolean

Accessors

accessToken

  • get accessToken(): string

    Returns string

  • set accessToken(token: string): void

    Parameters

    • token: string

    Returns void

apiClient

config

refreshToken

  • get refreshToken(): string

    Returns string

Methods

addListener

  • addListener<T extends "renewToken">(
        event: T,
        fn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void,
        context?: any,
    ): this

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • fn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void
    • Optionalcontext: any

    Returns this

createPost

emit

  • emit<T extends "renewToken">(
        event: T,
        ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">],
    ): boolean

    Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • ...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]

    Returns boolean

eventNames

  • eventNames(): "renewToken"[]

    Return an array listing the events for which the emitter has registered listeners.

    Returns "renewToken"[]

getPost

getSelf

getUser

  • getUser<M extends boolean = boolean>(username: string): JikeUser

    获取用户

    Type Parameters

    • M extends boolean = boolean

      是否为自己

      • true: 是
      • false: 否
      • boolean: 未知 （默认）

    Parameters

    • username: string

      用户名

    Returns JikeUser

    JikeUser 实例

listenerCount

  • listenerCount(event: "renewToken"): number

    Return the number of listeners listening to a given event.

    Parameters

    • event: "renewToken"

    Returns number

listeners

  • listeners<T extends "renewToken">(
        event: T,
    ): (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void[]

    Return the listeners registered for a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T

    Returns (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void[]

loginWithPassword

  • loginWithPassword(
        areaCode: string | number,
        mobile: string,
        password: string,
    ): Promise<void>

    密码登录

    Parameters

    • areaCode: string | number

      区号，如 +86

    • mobile: string

      手机号

    • password: string

      密码

    Returns Promise<void>

    Throws

    RequestFailureError 请求失败错误

loginWithSmsCode

  • loginWithSmsCode(
        areaCode: string | number,
        mobile: string,
        smsCode: string | number,
    ): Promise<void>

    短信登录

    Parameters

    • areaCode: string | number

      区号，如 +86

    • mobile: string

      手机号

    • smsCode: string | number

      短信验证码

    Returns Promise<void>

    Throws

    RequestFailureError 请求失败错误

off

  • off<T extends "renewToken">(
        event: T,
        fn?: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void,
        context?: any,
        once?: boolean,
    ): this

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • Optionalfn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void
    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

on

  • on<T extends "renewToken">(
        event: T,
        fn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void,
        context?: any,
    ): this

    Add a listener for a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • fn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void
    • Optionalcontext: any

    Returns this

once

  • once<T extends "renewToken">(
        event: T,
        fn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void,
        context?: any,
    ): this

    Add a one-time listener for a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • fn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void
    • Optionalcontext: any

    Returns this

queryFollowingUpdates

  • queryFollowingUpdates(
        option?: PaginatedOption<
            FollowingUpdate,
            "createdAt",
            | undefined
            | {
                lastPageEarliestTime: number;
                lastReadTime: number;
                session: "PopulatedUpdate";
            },
        >,
    ): Promise<
        (JikePostWithDetail | { actionTime: string } & Entity.PersonalUpdate)[],
    >

    查询关注动态

    Parameters

    • option: PaginatedOption<
          FollowingUpdate,
          "createdAt",
          | undefined
          | {
              lastPageEarliestTime: number;
              lastReadTime: number;
              session: "PopulatedUpdate";
          },
      > = {}

    Returns Promise<(JikePostWithDetail | { actionTime: string } & Entity.PersonalUpdate)[]>

queryNotifications

  • queryNotifications(
        option?: PaginatedOption<
            Notification,
            "createdAt"
            | "updatedAt",
            string,
        >,
        withMerged?: boolean,
    ): Promise<Notification[]>

    查询通知

    Parameters

    Returns Promise<Notification[]>

removeAllListeners

  • removeAllListeners(event?: "renewToken"): this

    Remove all listeners, or those of the specified event.

    Parameters

    • Optionalevent: "renewToken"

    Returns this

removeListener

  • removeListener<T extends "renewToken">(
        event: T,
        fn?: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void,
        context?: any,
        once?: boolean,
    ): this

    Remove the listeners of a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • Optionalfn: (...args: ArgumentMap<EventMap>[Extract<T, "renewToken">]) => void
    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

renewToken

  • renewToken(): Promise<void>

    刷新 access token

    Returns Promise<void>

sendSmsCode

  • sendSmsCode(areaCode: string | number, mobile: string): Promise<void>

    发送短信验证码

    Parameters

    • areaCode: string | number

      区号，如 +86

    • mobile: string

      手机号

    Returns Promise<void>

    Throws

    RequestFailureError 请求失败错误

serialize

  • serialize(space?: number): Promise<string>

    序列化

    Parameters

    • space: number = 0

      缩进空格数

    Returns Promise<string>

toJSON

Staticdeserialize

  • deserialize(data: string): JikeClient

    反序列化

    Parameters

    • data: string

      数据

    Returns JikeClient

StaticfromJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods