생성자
constructor
client): CommunitiesClient
새 커뮤니티 클라이언트 인스턴스를 생성합니다
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
client | Client | 주요 X API 클라이언트 인스턴스 |
반환
CommunitiesClient
정의 위치
메서드
getById
id, options?): Promise<Get2CommunitiesIdResponse>
ID로 커뮤니티 가져오기
ID로 특정 커뮤니티의 세부 정보를 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 커뮤니티의 id입니다. |
options | GetByIdOptions | - |
반환
Promise<Get2CommunitiesIdResponse>
API 응답으로 해석되는 Promise
정의됨
communities/client.ts:85search
query, options?): Promise<Get2CommunitiesSearchResponse>
커뮤니티 검색
지정한 검색어와 일치하는 커뮤니티 목록을 가져옵니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
query | string | 커뮤니티를 검색할 때 사용하는 쿼리입니다. |
options | SearchOptions | - |
반환
Promise<Get2CommunitiesSearchResponse>
API 응답으로 resolve되는 Promise