Class JikeClient

Hierarchy

Constructors

constructor

Properties

#client #config #refreshToken #userCache prefixed

Accessors

accessToken apiClient config refreshToken

Methods

addListener beforeRetry createClient 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): JikeClient

  • Parameters

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

    Returns JikeClient

Properties

Private #client

#client: {
    comments: api/comments;
    mediaMeta: api/media-meta;
    notifications: api/notifications;
    personalUpdate: api/personal-update;
    posts: api/posts;
    recommendFeed: api/recommend-feed;
    stories: api/stories;
    topics: api/topics;
    upload: api/upload;
    userRelation: api/user-relation;
    users: api/users;
}

Type declaration

Private #config

#config: ApiConfigResolved

Private #refreshToken

#refreshToken: string

Private #userCache

#userCache: {
    [userSelfKey]?: JikeUser<true>;
} & Record<string, JikeUser<boolean>> = {}

Type declaration

Static prefixed

prefixed: string | boolean

Accessors

accessToken

  • get accessToken(): string

  • Returns string

  • set accessToken(token): void

  • Parameters

    • token: string

    Returns void

apiClient

config

refreshToken

  • get refreshToken(): string

  • Returns string

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

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

          Returns void

    • Optional context: any

    Returns this

Private beforeRetry

  • beforeRetry(__namedParameters): Promise<boolean>

  • Parameters

    • __namedParameters: BeforeRetryState

    Returns Promise<boolean>

Private createClient

  • createClient(): void

  • Returns void

createPost

  • createPost(type, content, options?): Promise<{
        post: JikePostWithDetail;
        toast: string;
    }>

  • Parameters

    Returns Promise<{
        post: JikePostWithDetail;
        toast: string;
    }>

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • Rest ...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>(username): JikeUser<boolean>

  • 获取用户

    Type Parameters

    • M extends boolean = boolean

      是否为自己

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

    Parameters

    • username: string

      用户名

    Returns JikeUser<boolean>

    JikeUser 实例

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: "renewToken"

    Returns number

listeners

  • listeners<T>(event): ((...args) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T

    Returns ((...args) => void)[]

loginWithPassword

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

  • 密码登录

    Parameters

    • areaCode: string | number

      区号，如 +86

    • mobile: string

      手机号

    • password: string

      密码

    Returns Promise<void>

    Throws

    RequestFailureError 请求失败错误

loginWithSmsCode

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

  • 短信登录

    Parameters

    • areaCode: string | number

      区号，如 +86

    • mobile: string

      手机号

    • smsCode: string | number

      短信验证码

    Returns Promise<void>

    Throws

    RequestFailureError 请求失败错误

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

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

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

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

          Returns void

    • Optional context: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

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

          Returns void

    • Optional context: any

    Returns this

queryFollowingUpdates

queryNotifications

  • queryNotifications(option?, withMerged?): Promise<Notification[]>

  • 查询通知

    Parameters

    Returns Promise<Notification[]>

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: "renewToken"

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends "renewToken"

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

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

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

renewToken

  • renewToken(): Promise<void>

  • 刷新 access token

    Returns Promise<void>

sendSmsCode

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

  • 发送短信验证码

    Parameters

    • areaCode: string | number

      区号，如 +86

    • mobile: string

      手机号

    Returns Promise<void>

    Throws

    RequestFailureError 请求失败错误

serialize

  • serialize(space?): Promise<string>

  • 序列化

    Parameters

    • space: number = 0

      缩进空格数

    Returns Promise<string>

toJSON

Static deserialize

  • deserialize(data): JikeClient

  • 反序列化

    Parameters

    • data: string

      数据

    Returns JikeClient

Static fromJSON

Settings

Member Visibility

Theme

On This Page

constructor#client#config#refreshToken#userCacheprefixedaccessTokenapiClientconfigrefreshTokenaddListenerbeforeRetrycreateClientcreatePostemiteventNamesgetPostgetSelfgetUserlistenerCountlistenersloginWithPasswordloginWithSmsCodeoffononcequeryFollowingUpdatesqueryNotificationsremoveAllListenersremoveListenerrenewTokensendSmsCodeserializetoJSONdeserializefromJSON