Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
कम्युनिटीज़ ऑपरेशंस के लिए Client
यह Client, X API के communities endpoints के साथ इंटरैक्ट करने के लिए methods प्रदान करता है।
यह सभी communities-संबंधित operations के लिए authentication, request formatting और response
parsing को संभालता है।
• new CommunitiesClient(client): CommunitiesClient
एक नया CommunitiesClient इंस्टेंस बनाता है
| नाम | type | विवरण |
|---|
client | Client | मुख्य X API क्लाइंट इंस्टेंस |
CommunitiesClient
communities/client.ts:102
▸ 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(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
