ListsClient

리스트 작업용 클라이언트

이 클라이언트는 X API의 리스트 엔드포인트와 상호작용하기 위한 메서드를 제공합니다. 리스트 관련 모든 작업에 대해 인증, 요청 서식화, 응답 파싱을 처리합니다.

​

생성자

​

constructor

• new ListsClient(client): ListsClient

새로운 Lists 클라이언트 인스턴스를 생성합니다

​

매개변수

이름	유형	설명
client	Client	주 X API 클라이언트 인스턴스

​

반환값

ListsClient

​

정의 위치

lists/client.ts:188

​

메서드

​

getFollowers

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

리스트 팔로워 가져오기 지정된 ID의 특정 리스트를 팔로우하는 사용자 목록을 조회합니다.

​

매개변수

이름	유형	설명
id	string	리스트의 id.
options	GetFollowersOptions	-

​

반환

Promise<Get2ListsIdFollowersResponse>

API 응답으로 resolve되는 Promise

​

정의 위치

lists/client.ts:205

---

​

getMembers

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

List 구성원 가져오기 지정한 ID의 특정 List에 속한 사용자들을 조회합니다.

​

매개변수

이름	유형	설명
id	string	목록의 id입니다.
options	GetMembersOptions	-

​

반환

Promise<Get2ListsIdMembersResponse>

API 응답으로 해소되는 Promise

​

정의 위치

lists/client.ts:279

---

​

addMember

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

목록 멤버 추가 지정한 ID의 특정 목록에 사용자를 추가합니다.

​

매개변수

이름	유형	설명
id	string	멤버를 추가할 리스트의 id입니다.
options	AddMemberOptions	-

​

반환값

Promise<ListMutateResponse>

API 응답으로 해소되는 Promise

​

정의됨

lists/client.ts:353

---

​

removeMemberByUserId

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

리스트 멤버 제거 지정된 List의 ID와 User의 ID를 사용하여 해당 User를 해당 List에서 제거합니다.

​

매개변수

이름	타입	설명
id	string	멤버를 제거할 목록의 id입니다.
userId	string	목록에서 제거할 사용자의 id입니다.

​

반환값

Promise<ListMutateResponse>

API 응답으로 해소되는 Promise

​

정의 위치

lists/client.ts:405

---

​

getPosts

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

리스트 Post 가져오기 지정된 ID의 특정 리스트와 연결된 Post 목록을 가져옵니다.

​

매개변수

이름	타입	설명
id	string	List의 ID입니다.
options	GetPostsOptions	-

​

반환

Promise<Get2ListsIdTweetsResponse>

API 응답으로 해결되는 Promise

​

정의 위치

lists/client.ts:448

---

​

getById

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

ID로 List 가져오기 지정한 ID에 해당하는 특정 List의 상세 정보를 조회합니다.

​

매개변수

이름	타입	설명
id	string	리스트의 id
options	GetByIdOptions	-

​

반환

Promise<Get2ListsIdResponse>

API 응답으로 해소되는 Promise

​

정의된 위치

lists/client.ts:540

---

​

update

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

List 업데이트 인증된 사용자가 소유한 특정 List의 세부 정보를 해당 ID로 업데이트합니다.

​

매개변수

이름	타입	설명
id	string	수정할 리스트의 id입니다.
options	UpdateOptions	-

​

반환값

Promise<ListUpdateResponse>

API 응답으로 resolve되는 Promise

​

정의 위치

lists/client.ts:602

---

​

delete

▸ delete(id): Promise<ListDeleteResponse>

리스트 삭제 인증된 사용자가 소유한 특정 리스트를 ID로 삭제합니다.

​

매개변수

이름	타입	설명
id	string	삭제할 목록의 id입니다.

​

반환

Promise<ListDeleteResponse>

API 응답으로 이행되는 Promise

​

정의된 위치

lists/client.ts:650

---

​

create

▸ create(options?): Promise<ListCreateResponse>

List 생성 인증된 사용자에 대해 새로운 List를 생성합니다.

​

매개변수

이름	유형
options	CreateOptions

​

반환

Promise<ListCreateResponse>

API 응답으로 resolve되는 Promise

​

정의됨

lists/client.ts:684