Client 客户端

X API 的主客户端类

这是与 X API 交互的主要入口点。它通过专用的客户端模块访问所有 API 端点，并负责处理身份验证、请求配置和错误处理。

示例

import { Client } from '@xdevplatform/xdk';

const client = new Client({
  bearerToken: 'your-bearer-token'
});

// 获取用户信息
const user = await client.users.getUser('783214');

// 分页获取粉丝列表
const followers = await client.users.getFollowers('783214', {
  maxResults: 10,
  userFields: ['id', 'name', 'username']
});

// 遍历粉丝列表
for await (const follower of followers) {
  console.log(follower.username);
}

​

构造器

​

构造函数

• new Client(config): Client

创建新的 X API 客户端实例

​

参数

名称	类型	说明
config	any	客户端配置选项

​

返回

Client

示例

// Bearer Token 认证
const client = new Client({
  bearerToken: 'your-bearer-token' // 你的 Bearer Token
});

// OAuth2 认证
const client = new Client({
  accessToken: 'your-access-token' // 你的访问令牌
});

// OAuth1 认证
const client = new Client({
  oauth1: oauth1Instance
});

client.ts:306

​

属性

baseUrl · string · required

用于 API 请求的基准 URL

bearerToken · string

用于身份验证的 Bearer 令牌

accessToken · string

OAuth2 访问令牌

oauth1 · any

用于身份验证的 OAuth1 实例

headers · Headers · required

请求头

timeout · number · required

请求超时时间（毫秒）

retry · boolean · required

是否自动重试失败的请求

maxRetries · number · required

最大重试次数

userAgent · string · required

User-Agent 字符串

httpClient · HttpClient = httpClient · required

用于发起请求的 HTTP 客户端

users · UsersClient · required

Users 客户端

communityNotes · CommunityNotesClient · required

Community Notes 客户端

lists · ListsClient · required

Lists 客户端

connections · ConnectionsClient · required

Connections 客户端

posts · PostsClient · required

Posts 客户端

spaces · SpacesClient · required

Spaces 客户端

media · MediaClient · required

Media 客户端

directMessages · DirectMessagesClient · required

Direct Messages 客户端

communities · CommunitiesClient · required

Communities 客户端

accountActivity · AccountActivityClient · required

Account Activity 客户端

webhooks · WebhooksClient · required

Webhooks 客户端

trends · TrendsClient · required

Trends 客户端

activity · ActivityClient · required

Activity 客户端

stream · StreamClient · required

Stream 客户端

usage · UsageClient · required

Usage 客户端

compliance · ComplianceClient · required

Compliance 客户端

general · GeneralClient · required

General 客户端

request · Promise<T> · required

向 X API 发起已认证的请求

此方法负责所有 API 请求的身份验证、请求格式化和错误处理，并会根据客户端配置自动添加相应的身份验证请求头。

isTokenExpired · boolean · required

检查 OAuth2 令牌是否过期

refreshToken · Promise<void> · required

刷新 OAuth2 令牌

isAuthenticated · boolean · required

获取当前身份验证状态

mapSecuritySchemeToAuthTypes · string[] · required

将 OpenAPI 安全方案名称映射为内部身份验证类型

validateAuthentication · void · required

验证所需的身份验证方式是否可用

getAvailableAuthTypes · string[] · required

获取可用的身份验证类型