CommunitiesClient

커뮤니티 관련 작업을 위한 Client

이 Client는 X API의 커뮤니티 관련 엔드포인트와 상호작용하기 위한 메서드를 제공합니다. 인증, 요청 포맷 구성, 응답 파싱을 처리하여 커뮤니티 관련 모든 작업을 수행합니다.

​

생성자

​

constructor

• new CommunitiesClient(client): CommunitiesClient

새 CommunitiesClient 인스턴스를 생성합니다

​

매개변수

Name	Type	Description
client	Client	기본 X API Client 인스턴스

​

반환

CommunitiesClient

​

정의된 위치

communities/client.ts:102

​

메서드

​

search

▸ search(query, options): Promise<Response>

커뮤니티 검색 지정된 검색 쿼리에 해당하는 커뮤니티 리스트를 조회합니다.

​

매개변수

Name	Type	Description
query	string	커뮤니티를 검색하는 쿼리입니다.
options	SearchOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답을 resolve하는 Promise이며, requestOptions.raw가 true인 경우 원시 Response입니다.

​

정의된 위치

communities/client.ts:147

▸ search(query, options?): Promise<Get2CommunitiesSearchResponse>

​

매개변수

이름	type
query	string
options?	SearchOptions

​

반환값

Promise<Get2CommunitiesSearchResponse>

​

정의 위치

communities/client.ts:160

---

​

getById

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

커뮤니티 ID로 가져오기
지정된 커뮤니티 ID를 사용해 해당 커뮤니티의 세부 정보를 조회합니다.

​

매개변수

이름	타입	설명
id	string	커뮤니티 ID입니다.
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다.

​

정의 위치

communities/client.ts:352

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

​

매개변수

이름	타입
id	string
options?	GetByIdOptions

​

반환값

Promise<Get2CommunitiesIdResponse>

​

정의 위치

communities/client.ts:365