ActivityClient

गतिविधि ऑपरेशनों के लिए Client

यह Client X API के गतिविधि एंडपॉइंट्स के साथ इंटरैक्ट करने के लिए मेथड उपलब्ध कराता है। यह सभी गतिविधि-संबंधित ऑपरेशनों के लिए प्रमाणीकरण, अनुरोध फ़ॉर्मैटिंग और रिस्पॉन्स पार्सिंग को संभालता है।

​

कंस्ट्रक्टर

​

constructor

• new ActivityClient(client): ActivityClient

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

​

पैरामीटर

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

​

रिटर्न

ActivityClient

​

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

activity/client.ts:118

​

मेथड्स

​

getSubscriptions

▸ getSubscriptions(options): Promise<Response>

X गतिविधि सदस्यताएँ प्राप्त करता है XAA के लिए सक्रिय सदस्यताओं की सूची प्राप्त करता है

​

पैरामीटर

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

​

रिटर्न्स

Promise<Response>

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

​

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

activity/client.ts:159

▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

​

रिटर्न

Promise<ActivitySubscriptionGetResponse>

​

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

activity/client.ts:168

---

​

createSubscription

▸ createSubscription(options): Promise<Response>

X गतिविधि सदस्यता बनाएँ X गतिविधि इवेंट के लिए सदस्यता बनाता है

​

पैरामीटर

नाम	Type
options	CreateSubscriptionOptions & { requestOptions: { raw: true } }

​

रिटर्न

Promise<Response>

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

​

इसमें परिभाषित

activity/client.ts:237

▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

​

पैरामीटर

नाम	Type
options?	CreateSubscriptionOptions

​

देता है

Promise<ActivitySubscriptionCreateResponse>

​

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

activity/client.ts:246

---

​

stream

▸ stream(options): Promise<Response>

गतिविधि स्ट्रीम X गतिविधियों की स्ट्रीम

​

पैरामीटर

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

​

लौटाता है

Promise<Response>

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

​

में परिभाषित

activity/client.ts:332

▸ stream(options?): Promise<ActivityStreamingResponse>

​

पैरामीटर

नाम	type
options?	StreamOptions

​

रिटर्न

Promise<ActivityStreamingResponse>

​

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

activity/client.ts:341

---

​

updateSubscription

▸ updateSubscription(subscriptionId, options): Promise<Response>

X गतिविधि सदस्यता को अपडेट करता है X गतिविधि इवेंट के लिए किसी सदस्यता को अपडेट करता है

​

पैरामीटर

नाम	प्रकार	विवरण
subscriptionId	string	अपडेट की जाने वाली सदस्यता की ID।
options	UpdateSubscriptionOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

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

​

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

activity/client.ts:487

▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>

​

पैरामीटर

नाम	type
subscriptionId	string
options?	UpdateSubscriptionOptions

​

रिटर्न करता है

Promise<ActivitySubscriptionUpdateResponse>

​

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

activity/client.ts:500

---

​

deleteSubscription

▸ deleteSubscription(subscriptionId, options): Promise<Response>

X गतिविधि सदस्यता को हटाता है X गतिविधि इवेंट के लिए सदस्यता हटाता है

​

पैरामीटर

नाम	प्रकार	विवरण
subscriptionId	string	हटाई जाने वाली सदस्यता का id।
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

रिटर्न्स

Promise<Response>

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

​

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

activity/client.ts:602

▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

​

पैरामीटर

नाम	Type
subscriptionId	string

​

लौटाया गया मान

Promise<ActivitySubscriptionDeleteResponse>

​

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

activity/client.ts:615