CommunitiesClient

कम्युनिटीज़ ऑपरेशंस के लिए Client

यह Client, X API के communities endpoints के साथ इंटरैक्ट करने के लिए methods प्रदान करता है। यह सभी communities-संबंधित operations के लिए authentication, request formatting और response parsing को संभालता है।

​

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

​

constructor

• new CommunitiesClient(client): CommunitiesClient

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

​

पैरामीटर

नाम	type	विवरण
client	Client	मुख्य X API क्लाइंट इंस्टेंस

​

रिटर्न

CommunitiesClient

​

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

communities/client.ts:102

​

मेथड्स

​

search

▸ search(query, options): Promise<Response>

Communities खोजें निर्दिष्ट खोज क्वेरी से मेल खाने वाली Communities की सूची प्राप्त करता है।

​

पैरामीटर

नाम	type	विवरण
query	string	कम्युनिटीज़ खोजने की क्वेरी।
options	SearchOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

API response पर resolve होने वाला Promise, या अगर requestOptions.raw true हो, तो raw Response

​

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

communities/client.ts:147

▸ search(query, options?): Promise<Get2CommunitiesSearchResponse>

​

पैरामीटर

नाम	type
query	string
options?	SearchOptions

​

रिटर्न

Promise<Get2CommunitiesSearchResponse>

​

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

communities/client.ts:160

---

​

getById

▸ getById(id, options): Promise<Response>

ID के आधार पर Community प्राप्त करें किसी विशिष्ट Community का विवरण उसके ID के आधार पर प्राप्त करता है।

​

पैरामीटर

नाम	Type	विवरण
id	string	Community की id।
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

वह Promise जो API response पर resolve होता है, या raw Response अगर requestOptions.raw true है

​

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

communities/client.ts:352

▸ getById(id, options?): Promise<Get2CommunitiesIdResponse>

​

पैरामीटर

नाम	प्रकार
id	string
options?	GetByIdOptions

​

रिटर्न

Promise<Get2CommunitiesIdResponse>

​

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

communities/client.ts:365