ListsClient

सूची ऑपरेशनों के लिए Client

यह Client, X API के सूची एंडपॉइंट्स के साथ इंटरैक्ट करने के लिए मेथड उपलब्ध कराता है। यह सभी सूची-संबंधित ऑपरेशनों के लिए authentication, request formatting और रिस्पॉन्स parsing को संभालता है।

​

कंस्ट्रक्टर

​

constructor

• new ListsClient(client): ListsClient

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

​

पैरामीटर

नाम	type	विवरण
client	Client	मुख्य X API Client instance

​

रिटर्न

ListsClient

​

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

lists/client.ts:294

​

मेथड्स

​

getFollowers

▸ getFollowers(id, options): Promise<Response>

सूची के फ़ॉलोअर्स प्राप्त करें किसी विशिष्ट सूची के ID के आधार पर उसे फ़ॉलो करने वाले उपयोगकर्ताओं की सूची प्राप्त करता है।

​

पैरामीटर

नाम	type	विवरण
id	string	सूची की ID।
options	GetFollowersOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:339

▸ getFollowers(id, options?): Promise<Get2ListsIdFollowersResponse>

​

पैरामीटर

नाम	type
id	string
options?	GetFollowersOptions

​

रिटर्न

Promise<Get2ListsIdFollowersResponse>

​

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

lists/client.ts:352

---

​

create

▸ create(options): Promise<Response>

सूची बनाएँ प्रमाणित उपयोगकर्ता के लिए नई सूची बनाता है।

​

पैरामीटर

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

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:560

▸ create(options?): Promise<ListCreateResponse>

​

पैरामीटर

नाम	type
options?	CreateOptions

​

रिटर्न

Promise<ListCreateResponse>

​

में परिभाषित

lists/client.ts:569

---

​

getMembers

▸ getMembers(id, options): Promise<Response>

सूची के सदस्य प्राप्त करें उसकी id के आधार पर किसी विशिष्ट सूची के सदस्य उपयोगकर्ताओं की सूची प्राप्त करता है।

​

पैरामीटर

नाम	type	विवरण
id	string	सूची का पहचानकर्ता।
options	GetMembersOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:665

▸ getMembers(id, options?): Promise<Get2ListsIdMembersResponse>

​

पैरामीटर

नाम	type
id	string
options?	GetMembersOptions

​

रिटर्न

Promise<Get2ListsIdMembersResponse>

​

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

lists/client.ts:678

---

​

addMember

▸ addMember(id, options): Promise<Response>

सूची में सदस्य जोड़ें उसकी ID का उपयोग करके किसी विशिष्ट सूची में एक User जोड़ता है।

​

पैरामीटर

नाम	type	विवरण
id	string	उस सूची की ID जिसमें सदस्य जोड़ना है।
options	AddMemberOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:890

▸ addMember(id, options?): Promise<ListMutateResponse>

​

पैरामीटर

नाम	type
id	string
options?	AddMemberOptions

​

रिटर्न

Promise<ListMutateResponse>

​

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

lists/client.ts:903

---

​

getPosts

▸ getPosts(id, options): Promise<Response>

सूची के पोस्ट्स प्राप्त करें यह किसी विशिष्ट सूची से उसके ID के आधार पर संबद्ध पोस्ट्स की सूची प्राप्त करता है।

​

पैरामीटर

Name	type	Description
id	string	सूची की ID।
options	GetPostsOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:1011

▸ getPosts(id, options?): Promise<Get2ListsIdTweetsResponse>

​

पैरामीटर

नाम	type
id	string
options?	GetPostsOptions

​

रिटर्न

Promise<Get2ListsIdTweetsResponse>

​

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

lists/client.ts:1024

---

​

removeMemberByUserId

▸ removeMemberByUserId(id, userId, options): Promise<Response>

सूची सदस्य को हटाएँ किसी विशिष्ट सूची से उसकी ID और User की ID के आधार पर किसी User को हटाता है।

​

पैरामीटर

नाम	type	विवरण
id	string	उस सूची की ID, जिससे किसी सदस्य को हटाना है।
userId	string	उस उपयोगकर्ता की ID, जिसे सूची से हटाया जाएगा।
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:1303

▸ removeMemberByUserId(id, userId): Promise<ListMutateResponse>

​

पैरामीटर

नाम	type
id	string
userId	string

​

रिटर्न

Promise<ListMutateResponse>

​

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

lists/client.ts:1320

---

​

getById

▸ getById(id, options): Promise<Response>

ID से सूची प्राप्त करें किसी विशिष्ट सूची का विवरण उसकी ID से प्राप्त करता है।

​

पैरामीटर

नाम	type	विवरण
id	string	सूची का ID।
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:1423

▸ getById(id, options?): Promise<Get2ListsIdResponse>

​

पैरामीटर

नाम	type
id	string
options?	GetByIdOptions

​

रिटर्न

Promise<Get2ListsIdResponse>

​

में परिभाषित

lists/client.ts:1436

---

​

update

▸ update(id, options): Promise<Response>

सूची अपडेट करें प्रमाणीकृत उपयोगकर्ता के स्वामित्व वाली किसी विशिष्ट सूची के विवरण को उसकी ID के आधार पर अपडेट करता है।

​

पैरामीटर

नाम	type	विवरण
id	string	संशोधित की जाने वाली सूची का id।
options	UpdateOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:1610

▸ update(id, options?): Promise<ListUpdateResponse>

​

पैरामीटर

नाम	type
id	string
options?	UpdateOptions

​

रिटर्न

Promise<ListUpdateResponse>

​

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

lists/client.ts:1623

---

​

delete

▸ delete(id, options): Promise<Response>

सूची हटाएँ प्रमाणीकृत उपयोगकर्ता के स्वामित्व वाली किसी विशिष्ट सूची को उसके id के आधार पर हटाता है।

​

पैरामीटर

नाम	type	विवरण
id	string	हटाई जाने वाली सूची का ID।
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

रिटर्न

Promise<Response>

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

​

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

lists/client.ts:1731

▸ delete(id): Promise<ListDeleteResponse>

​

पैरामीटर

नाम	type
id	string

​

रिटर्न

Promise<ListDeleteResponse>

​

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

lists/client.ts:1744