paginator

X API SDK के लिए Cursor-आधारित पेजिनेशन यूटिलिटीज़।

यह मॉड्यूल सभी API क्लाइंट में सहज पेजिनेशन सपोर्ट के लिए एक Cursor क्लास प्रदान करता है। Cursor, उचित type safety के साथ, .pages() और .items() दोनों मेथड का उपयोग करके पेजिनेट किए गए परिणामों पर आसानी से iterate करने में सक्षम बनाता है।

​

class xdk.paginator.Cursor

[ResponseType]

​

पैरामीटर

path.method · PaginatableMethod

​

__init__

Cursor को इनिशियलाइज़ करें।

​

पैरामीटर

path.method · PaginatableMethod

हर पेज के लिए कॉल की जाने वाली API मेथड (इसे पेजिनेशन का समर्थन करना चाहिए)

​

items

पेजिनेटेड रिस्पॉन्स के अलग-अलग आइटम्स पर इटरेट करें।

​

पैरामीटर

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

लौटाए जाने वाले आइटमों की अधिकतम संख्या (असीमित के लिए None)

​

रिटर्न

IteratorAny

​

pages

रिस्पॉन्स के पेजों पर इटरेट करें।

​

पैरामीटर

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

लौटाए जाने वाले पृष्ठों की अधिकतम संख्या (None का मतलब असीमित है)

​

लौटाता है

IteratorResponseType

​

class xdk.paginator.PaginatableMethod

[ResponseType]

​

__init__

​

xdk.paginator.cursor

उचित type inference और validation के साथ एक cursor बनाएँ। यह factory function type inference में मदद करता है, ताकि आपको रिस्पॉन्स type के लिए सही type hints मिलें, और यह सत्यापित करता है कि method static analysis और runtime, दोनों में पेजिनेशन का समर्थन करता है।

​

पैरामीटर

path.method · PaginatableMethod

रैप की जाने वाली API मेथड (पेजिनेशन का समर्थन करना चाहिए)