ConnectionsClient

connections ऑपरेशनों के लिए Client

यह Client, X API के connections endpoints के साथ इंटरैक्ट करने के लिए मेथड उपलब्ध कराता है। यह authentication, request formatting और connections से संबंधित सभी ऑपरेशनों के लिए रिस्पॉन्स parsing को संभालता है।

​

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

​

constructor

• new ConnectionsClient(client): ConnectionsClient

एक नया connections client इंस्टेंस बनाता है

​

पैरामीटर

नाम	type	विवरण
client	Client	मुख्य X API Client instance

​

रिटर्न

ConnectionsClient

​

यहाँ परिभाषित किया गया है

connections/client.ts:88

​

मेथड्स

​

getConnectionHistory

▸ getConnectionHistory(options): Promise<Response>

कनेक्शन इतिहास प्राप्त करें प्रमाणीकृत ऐप के लिए, डिस्कनेक्ट होने के कारणों सहित सक्रिय और पुराने स्ट्रीमिंग कनेक्शन रिटर्न करता है।

​

पैरामीटर

नाम	type
options	GetConnectionHistoryOptions & { requestOptions: { raw: true } }

​

रिटर्न

Promise<Response>

ऐसा Promise जो API रिस्पॉन्स पर resolve होता है, या raw Response यदि requestOptions.raw true हो

​

यहाँ परिभाषित

connections/client.ts:129

▸ getConnectionHistory(options?): Promise<Get2ConnectionsResponse>

​

पैरामीटर

नाम	type
options?	GetConnectionHistoryOptions

​

रिटर्न

Promise<Get2ConnectionsResponse>

​

यहाँ परिभाषित है

connections/client.ts:138

---

​

deleteAll

▸ deleteAll(options): Promise<Response>

सभी कनेक्शन बंद करें प्रमाणीकृत ऐप के सभी सक्रिय स्ट्रीमिंग कनेक्शन बंद करता है।

​

पैरामीटर

नाम	type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

​

रिटर्न

Promise<Response>

API रिस्पॉन्स पर resolve होने वाला Promise, या अगर requestOptions.raw true है, तो raw Response

​

यहाँ परिभाषित है

connections/client.ts:318

▸ deleteAll(): Promise<KillAllConnectionsResponse>

​

रिटर्न

Promise<KillAllConnectionsResponse>

​

यहाँ परिभाषित है

connections/client.ts:327