Client

Classe Client principale pour X API

C’est le point d’entrée principal pour interagir avec X API. Elle fournit l’accès à tous les points de terminaison de l’API via des modules client spécialisés et gère l’authentification, la configuration des requêtes et la gestion des erreurs.

Exemple

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

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

// Récupérer les informations de l'utilisateur
const user = await client.users.getUser('783214');

// Récupérer les abonnés avec pagination
const followers = await client.users.getFollowers('783214', {
  maxResults: 10,
  userFields: ['id', 'name', 'username']
});

// Itérer sur les abonnés
for await (const follower of followers) {
  console.log(follower.username);
}

​

Constructeurs

​

constructeur

• new Client(config): Client

Crée une nouvelle instance du client X API

​

Paramètres

Nom	Type	Description
config	any	Options de configuration pour le Client

​

Valeur de retour

Client

Exemple

// Authentification par jeton Bearer
const client = new Client({
  bearerToken: 'your-bearer-token'
});

// OAuth2 authentication
const client = new Client({
  accessToken: 'your-access-token'
});

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

client.ts:401

​

Propriétés

baseUrl · string · requis

URL de base pour les requêtes API

bearerToken · string

Jeton Bearer pour l’authentification

accessToken · string

Jeton d’accès OAuth2

oauth1 · any

Instance OAuth1 pour l’authentification

headers · Headers · requis

En-têtes pour les requêtes

timeout · number · requis

Délai d’expiration de la requête en millisecondes

retry · boolean · requis

Indique s’il faut réessayer automatiquement les requêtes ayant échoué

maxRetries · number · requis

Nombre maximal de tentatives de réessai

httpClient · HttpClient = httpClient · requis

Client HTTP pour effectuer des requêtes

general · GeneralClient · requis

client général

accountActivity · AccountActivityClient · requis

client d’activité de compte

communityNotes · CommunityNotesClient · requis

client Community Notes

compliance · ComplianceClient · requis

client de conformité

connections · ConnectionsClient · requis

client de connexions

users · UsersClient · requis

client d’utilisateurs

news · NewsClient · requis

client d’actualités

spaces · SpacesClient · requis

client Spaces

activity · ActivityClient · requis

client d’activité

usage · UsageClient · requis

client d’utilisation

trends · TrendsClient · requis

client de tendances

posts · PostsClient · requis

client de Publications

directMessages · DirectMessagesClient · requis

client de messages privés

communities · CommunitiesClient · requis

client de communautés

media · MediaClient · requis

client de médias

webhooks · WebhooksClient · requis

client de webhooks

stream · StreamClient · requis

client de flux

lists · ListsClient · requis

client de Listes

request · Promise<T> · requis

Effectue une requête authentifiée vers X API

Cette méthode gère l’authentification, le formatage de la requête et la gestion des erreurs pour toutes les requêtes API. Elle ajoute automatiquement les en-têtes d’authentification appropriés en fonction de la configuration du client.

isTokenExpired · boolean · requis

Vérifie si le jeton OAuth2 est expiré

refreshToken · Promise<void> · requis

Actualise le jeton OAuth2

isAuthenticated · boolean · requis

Récupère l’état actuel de l’authentification

mapSecuritySchemeToAuthTypes · string[] · requis

Associe les noms de schémas de sécurité OpenAPI aux types d’authentification internes

validateAuthentication · void · requis

Valide que la méthode d’authentification requise est disponible

getAvailableAuthTypes · string[] · requis

Récupère les types d’authentification disponibles