मुख्य सामग्री पर जाएं
अकाउंट गतिविधि संचालन के लिए Client यह Client, X API के account activity endpoints के साथ इंटरैक्ट करने के लिए methods प्रदान करता है। यह authentication, request formatting, और account activity से संबंधित सभी operations के लिए रिस्पॉन्स parsing को संभालता है।

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

constructor

new AccountActivityClient(client): AccountActivityClient एक नया AccountActivityClient instance बनाता है

पैरामीटर

NameTypeDescription
clientClientमुख्य X API Client इंस्टेंस

रिटर्न

AccountActivityClient

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

account_activity/client.ts:70

मेथड्स

getSubscriptions

getSubscriptions(webhookId, options): Promise<Response> सदस्यताएँ प्राप्त करें किसी दिए गए webhook के लिए सभी सक्रिय सदस्यताओं की सूची प्राप्त करता है।

पैरामीटर

नामTypeविवरण
webhookIdstringवह webhook ID जिसके लिए सदस्यताएँ प्राप्त करनी हैं।
optionsObject-
options.requestOptionsObject-
options.requestOptions.rawtrue-

रिटर्न

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

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

account_activity/client.ts:115 getSubscriptions(webhookId): Promise<SubscriptionsListGetResponse>

पैरामीटर

नामType
webhookIdstring

रिटर्न

Promise<SubscriptionsListGetResponse>

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

account_activity/client.ts:128

deleteSubscription

deleteSubscription(webhookId, userId, options): Promise<Response> सदस्यता हटाएं दिए गए webhook और user ID के लिए Account Activity सदस्यता हटाता है।

पैरामीटर

नामtypeविवरण
webhookIdstringवह webhook ID जिसके लिए सदस्यता की जाँच करनी है।
userIdstringजिस उपयोगकर्ता की सदस्यता समाप्त करनी है, उसका user ID।
optionsObject-
options.requestOptionsObject-
options.requestOptions.rawtrue-

रिटर्न्स

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

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

account_activity/client.ts:217 deleteSubscription(webhookId, userId): Promise<SubscriptionsDeleteResponse>

पैरामीटर

नामtype
webhookIdstring
userIdstring

रिटर्न्स

Promise<SubscriptionsDeleteResponse>

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

account_activity/client.ts:234

validateSubscription

validateSubscription(webhookId, options): Promise<Response> सदस्यता को वैध करें दिए गए webhook के लिए उपयोगकर्ता के Account Activity सदस्यता की जाँच करता है।

पैरामीटर

नामtypeविवरण
webhookIdstringवह webhook ID जिसके लिए सदस्यता की जाँच करनी है।
optionsObject-
options.requestOptionsObject-
options.requestOptions.rawtrue-

रिटर्न

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

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

account_activity/client.ts:331 validateSubscription(webhookId): Promise<SubscriptionsGetResponse>

पैरामीटर

नामType
webhookIdstring

रिटर्न

Promise<SubscriptionsGetResponse>

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

account_activity/client.ts:344

createSubscription

createSubscription(webhookId, options): Promise<Response> सदस्यता बनाएँ उपयोगकर्ता और दिए गए webhook के लिए एक Account Activity सदस्यता बनाता है।

पैरामीटर

NameTypeDescription
webhookIdstringवह webhook ID जिसके लिए सदस्यता की जाँच करनी है।
optionsCreateSubscriptionOptions & { requestOptions: { raw: true } }-

रिटर्न

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

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

account_activity/client.ts:435 createSubscription(webhookId, options?): Promise<SubscriptionsCreateResponse>

पैरामीटर

नामtype
webhookIdstring
options?CreateSubscriptionOptions

रिटर्न

Promise<SubscriptionsCreateResponse>

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

account_activity/client.ts:448

createReplayJob

createReplayJob(webhookId, fromDate, toDate, options): Promise<Response> रीप्ले जॉब बनाएँ दिए गए webhook से संबद्ध सभी सदस्यताओं के लिए पिछले अधिकतम 5 दिनों की activities प्राप्त करने हेतु एक रीप्ले जॉब बनाता है।

पैरामीटर

NameTypeDescription
webhookIdstringwebhook कॉन्फ़िगरेशन का अद्वितीय पहचानकर्ता।
fromDatestringवह सबसे पुराना (प्रारंभिक) UTC टाइमस्टैम्प (समावेशी) जिससे yyyymmddhhmm फ़ॉर्मैट में इवेंट प्रदान किए जाएंगे।
toDatestringवह नवीनतम (अंतिम) UTC टाइमस्टैम्प (बहिष्कृत) जिस तक yyyymmddhhmm फ़ॉर्मैट in इवेंट प्रदान किए जाएंगे।
optionsObject-
options.requestOptionsObject-
options.requestOptions.rawtrue-

रिटर्न

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

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

account_activity/client.ts:564 createReplayJob(webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>

पैरामीटर

नामType
webhookIdstring
fromDatestring
toDatestring

रिटर्न्स

Promise<ReplayJobCreateResponse>

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

account_activity/client.ts:585

getSubscriptionCount

getSubscriptionCount(options): Promise<Response> सदस्यताओं की संख्या प्राप्त करें वर्तमान में सक्रिय Account Activity सदस्यताओं की कुल संख्या प्राप्त करता है।

पैरामीटर

नामtype
optionsObject
options.requestOptionsObject
options.requestOptions.rawtrue

रिटर्न्स

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

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

account_activity/client.ts:704 getSubscriptionCount(): Promise<SubscriptionsCountGetResponse>

रिटर्न

Promise<SubscriptionsCountGetResponse>

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

account_activity/client.ts:713