ListsClient

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

​

생성자

​

constructor

• new ListsClient(client): ListsClient 새 lists 클라이언트 인스턴스를 생성합니다

​

매개변수

​

반환값

ListsClient

​

정의 위치

lists/client.ts:294

​

메서드

​

getFollowers

▸ getFollowers(id, options): Promise<Response> Get List followers ID로 특정 List를 팔로우하는 사용자 목록을 검색합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:339 ▸ getFollowers(id, options?): Promise<Get2ListsIdFollowersResponse>

​

매개변수

​

반환값

Promise<Get2ListsIdFollowersResponse>

​

정의 위치

lists/client.ts:352

---

​

create

▸ create(options): Promise<Response> Create List 인증된 사용자에 대한 새 List를 생성합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:560 ▸ create(options?): Promise<ListCreateResponse>

​

매개변수

​

반환값

Promise<ListCreateResponse>

​

정의 위치

lists/client.ts:569

---

​

getMembers

▸ getMembers(id, options): Promise<Response> Get List members ID로 특정 List의 멤버인 사용자 목록을 검색합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:665 ▸ getMembers(id, options?): Promise<Get2ListsIdMembersResponse>

​

매개변수

​

반환값

Promise<Get2ListsIdMembersResponse>

​

정의 위치

lists/client.ts:678

---

​

addMember

▸ addMember(id, options): Promise<Response> Add List member ID로 특정 List에 사용자를 추가합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:890 ▸ addMember(id, options?): Promise<ListMutateResponse>

​

매개변수

​

반환값

Promise<ListMutateResponse>

​

정의 위치

lists/client.ts:903

---

​

getPosts

▸ getPosts(id, options): Promise<Response> Get List Posts ID로 특정 List와 연결된 Post 목록을 검색합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:1011 ▸ getPosts(id, options?): Promise<Get2ListsIdTweetsResponse>

​

매개변수

​

반환값

Promise<Get2ListsIdTweetsResponse>

​

정의 위치

lists/client.ts:1024

---

​

removeMemberByUserId

▸ removeMemberByUserId(id, userId, options): Promise<Response> Remove List member ID와 사용자 ID로 특정 List에서 사용자를 제거합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:1303 ▸ removeMemberByUserId(id, userId): Promise<ListMutateResponse>

​

매개변수

​

반환값

Promise<ListMutateResponse>

​

정의 위치

lists/client.ts:1320

---

​

getById

▸ getById(id, options): Promise<Response> Get List by ID ID로 특정 List의 세부 정보를 검색합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:1423 ▸ getById(id, options?): Promise<Get2ListsIdResponse>

​

매개변수

​

반환값

Promise<Get2ListsIdResponse>

​

정의 위치

lists/client.ts:1436

---

​

update

▸ update(id, options): Promise<Response> Update List ID로 인증된 사용자가 소유한 특정 List의 세부 정보를 업데이트합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:1610 ▸ update(id, options?): Promise<ListUpdateResponse>

​

매개변수

​

반환값

Promise<ListUpdateResponse>

​

정의 위치

lists/client.ts:1623

---

​

delete

▸ delete(id, options): Promise<Response> Delete List ID로 인증된 사용자가 소유한 특정 List를 삭제합니다.

​

매개변수

​

반환값

Promise<Response> API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

​

정의 위치

lists/client.ts:1731 ▸ delete(id): Promise<ListDeleteResponse>

​

매개변수

​

반환값

Promise<ListDeleteResponse>

​

정의 위치

lists/client.ts:1744