CommunitiesClient

​

उप-मॉड्यूल

• xdk.communities.client मॉड्यूल
  • CommunitiesClient
    • CommunitiesClient.__init__()
    • CommunitiesClient.get_by_id()
    • CommunitiesClient.search()
• xdk.communities.models मॉड्यूल
  • GetByIdResponse
    • GetByIdResponse.model_config
  • SearchResponse
    • SearchResponse.model_config

​

मॉड्यूल की सामग्री

यह मॉड्यूल X API के कम्युनिटीज़ एंडपॉइंट्स तक पहुंच प्रदान करता है और कम्युनिटीज़ से जुड़ी सभी कार्यक्षमताओं के लिए मुख्य प्रवेश बिंदु के रूप में काम करता है।

​

class xdk.communities.CommunitiesClient

कम्युनिटीज़ संचालन के लिए Client

​

पैरामीटर

path.client · Client

​

__init__

​

पैरामीटर

path.client · Client

​

get_by_id

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

​

पैरामीटर

path.id · Any

Community की ID।

path.community_fields · List or None · डिफ़ॉल्ट: "None"

दिखाने के लिए Community फ़ील्ड्स की अल्पविराम से अलग की गई सूची।

​

रिटर्न

GetByIdResponse - प्रतिक्रिया डेटा

​

search

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

​

पैरामीटर

path.query · str

कम्युनिटीज़ खोजने की क्वेरी।

path.max_results · int or None · डिफ़ॉल्ट: "None"

किसी अनुरोध में लौटाए जाने वाले खोज परिणामों की अधिकतम संख्या।

path.next_token · Any or None · डिफ़ॉल्ट: "None"

इस पैरामीटर का उपयोग परिणामों का अगला ‘पेज’ प्राप्त करने के लिए किया जाता है। इसके साथ उपयोग किया जाने वाला मान API द्वारा दिए गए रिस्पॉन्स से सीधे लिया जाता है और इसे संशोधित नहीं किया जाना चाहिए।

path.pagination_token · Any or None · डिफ़ॉल्ट: "None"

इस पैरामीटर का उपयोग परिणामों का अगला ‘पेज’ प्राप्त करने के लिए किया जाता है। इसके साथ उपयोग किया जाने वाला मान API द्वारा दिए गए रिस्पॉन्स से सीधे लिया जाता है और इसे संशोधित नहीं किया जाना चाहिए।

path.community_fields · List or None · डिफ़ॉल्ट: "None"

प्रदर्शित किए जाने वाले Community फ़ील्ड्स की अल्पविराम से अलग की गई सूची।

​

रिटर्न

IteratorSearchResponse