생성자
constructor
client): SpacesClient
새로운 Spaces 클라이언트 인스턴스를 생성합니다
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
client | Client | 주 X API 클라이언트 인스턴스 |
반환
SpacesClient
정의
spaces/client.ts:190메소드
getByIds
ids, options?): Promise<Get2SpacesResponse>
ID로 Spaces 가져오기
여러 Space의 세부 정보를 해당 id로 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
ids | any[] | 반환할 Space id 목록입니다. |
options | GetByIdsOptions | - |
반환
Promise<Get2SpacesResponse>
API 응답으로 이행되는 Promise
정의 위치
spaces/client.ts:207search
query, options?): Promise<Get2SpacesSearchResponse>
Spaces 검색
지정한 검색어와 일치하는 Spaces 목록을 검색합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
query | string | 검색어입니다. |
options | SearchOptions | - |
반환
Promise<Get2SpacesSearchResponse>
API 응답으로 resolve되는 Promise
정의됨
spaces/client.ts:277getBuyers
id, options?): Promise<Get2SpacesIdBuyersResponse>
Space 티켓 구매자 조회
ID로 지정한 특정 Space의 티켓을 구매한 사용자 목록을 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 조회할 Space의 id입니다. |
options | GetBuyersOptions | - |
반환값
Promise<Get2SpacesIdBuyersResponse>
API 응답으로 이행되는 Promise
정의됨
spaces/client.ts:359getPosts
id, options?): Promise<Get2SpacesIdTweetsResponse>
Space의 Post 가져오기
특정 Space에서 공유된 Post 목록을 해당 Space의 ID로 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 조회할 Space의 id입니다. |
options | GetPostsOptions | - |
반환
Promise<Get2SpacesIdTweetsResponse>
API 응답으로 resolve되는 Promise
정의됨
spaces/client.ts:433getById
id, options?): Promise<Get2SpacesIdResponse>
ID로 Space 가져오기
지정한 ID의 특정 Space의 세부 정보를 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 조회할 Space의 id입니다. |
options | GetByIdOptions | - |
반환
Promise<Get2SpacesIdResponse>
API 응답으로 resolve되는 Promise
정의됨
spaces/client.ts:519getByCreatorIds
userIds, options?): Promise<Get2SpacesByCreatorIdsResponse>
크리에이터 ID로 Spaces 조회
지정한 User ID가 생성한 Spaces의 상세 정보를 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
userIds | any[] | 조회 대상 사용자 id 목록입니다. |
options | GetByCreatorIdsOptions | - |
반환
Promise<Get2SpacesByCreatorIdsResponse>
API 응답으로 resolve되는 Promise