मुख्य सामग्री पर जाएं
X API के लिए मुख्य Client क्लास यह X API के साथ इंटरैक्ट करने का मुख्य एंट्री पॉइंट है। यह विशेष Client मॉड्यूलों के माध्यम से सभी 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);
}

कंस्ट्रक्टर्स

constructor

new Client(config): Client एक नया X API Client instance बनाता है

पैरामीटर

नामtypeविवरण
configanyClient के लिए कॉन्फ़िगरेशन विकल्प

रिटर्न

Client उदाहरण
// बेयरर टोकन प्रमाणीकरण
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:401

गुण

baseUrl
string
आवश्यक
API अनुरोधों के लिए बेस URL
bearerToken
string
प्रमाणीकरण के लिए बेयरर टोकन
accessToken
string
OAuth2 एक्सेस टोकन
oauth1
any
प्रमाणीकरण के लिए OAuth1 इंस्टेंस
headers
Headers
आवश्यक
अनुरोधों के लिए हेडर्स
timeout
number
आवश्यक
मिलीसेकंड में अनुरोध का टाइमआउट
retry
boolean
आवश्यक
क्या विफल अनुरोधों को अपने-आप फिर से आज़माया जाए
maxRetries
number
आवश्यक
फिर से प्रयास करने की अधिकतम संख्या
httpClient
HttpClient = httpClient
आवश्यक
अनुरोध भेजने के लिए HTTP Client
general
GeneralClient
आवश्यक
सामान्य Client
accountActivity
AccountActivityClient
आवश्यक
अकाउंट गतिविधि Client
communityNotes
CommunityNotesClient
आवश्यक
कम्युनिटी नोट्स Client
compliance
ComplianceClient
आवश्यक
अनुपालन Client
connections
ConnectionsClient
आवश्यक
कनेक्शंस Client
users
UsersClient
आवश्यक
यूज़र्स Client
news
NewsClient
आवश्यक
समाचार Client
spaces
SpacesClient
आवश्यक
स्पेसेज़ Client
activity
ActivityClient
आवश्यक
गतिविधि Client
usage
UsageClient
आवश्यक
उपयोग Client
ट्रेंड्स Client
posts
PostsClient
आवश्यक
पोस्ट्स Client
directMessages
DirectMessagesClient
आवश्यक
डायरेक्ट मैसेजेस Client
communities
CommunitiesClient
आवश्यक
कम्युनिटीज़ Client
media
MediaClient
आवश्यक
मीडिया Client
webhooks
WebhooksClient
आवश्यक
वेबहुक्स Client
stream
StreamClient
आवश्यक
स्ट्रीम Client
lists
ListsClient
आवश्यक
सूचियाँ Client
request
Promise<T>
आवश्यक
X API के लिए प्रमाणीकृत अनुरोध करेंयह मेथड सभी API अनुरोधों के लिए प्रमाणीकरण, अनुरोध फ़ॉर्मैटिंग और त्रुटि प्रबंधन संभालता है। यह Client कॉन्फ़िगरेशन के आधार पर उपयुक्त प्रमाणीकरण हेडर्स अपने-आप जोड़ता है।
isTokenExpired
boolean
आवश्यक
जाँचें कि OAuth2 टोकन की समय-सीमा समाप्त हो गई है या नहीं
refreshToken
Promise<void>
आवश्यक
OAuth2 टोकन को रिफ्रेश करें
isAuthenticated
boolean
आवश्यक
मौजूदा प्रमाणीकरण स्थिति प्राप्त करें
mapSecuritySchemeToAuthTypes
string[]
आवश्यक
OpenAPI सुरक्षा स्कीम नामों को आंतरिक प्रमाणीकरण प्रकारों से मैप करें
validateAuthentication
void
आवश्यक
सत्यापित करें कि आवश्यक प्रमाणीकरण विधि उपलब्ध है
getAvailableAuthTypes
string[]
आवश्यक
उपलब्ध प्रमाणीकरण प्रकार प्राप्त करें