クライアント

X API のクライアントのメインクラス

これは X API を操作するための主要なエントリポイントです。専用のクライアントモジュールを通じて すべての API エンドポイントにアクセスでき、認証、リクエストの設定、エラー処理を行います。

Example

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);
}

​

コンストラクタ

​

constructor

• new Client(config): Client

新しい X API クライアント インスタンスを作成します

​

パラメータ

名前	型	説明
config	any	クライアントの設定オプション

​

返り値

Client

例

// Bearerトークン認証
const client = new Client({
  bearerToken: 'your-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

ユーザー エージェント文字列

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

利用可能な認証タイプを取得する