생성자
constructor
client): SpacesClient
새로운 SpacesClient 인스턴스를 생성합니다
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
client | Client | 주 X API Client 인스턴스 |
반환
SpacesClient
정의된 위치
메서드
getByIds
ids, options): Promise<Response>
ID로 Spaces 조회
여러 개의 Space에 대한 세부 정보를 해당 ID로 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
ids | any[] | 반환할 Space ID 목록입니다. |
options | GetByIdsOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise입니다. requestOptions.raw가 true인 경우 원시 Response를 반환합니다
정의 위치
spaces/client.ts:361 ▸ getByIds(ids, options?): Promise<Get2SpacesResponse>
매개변수
| 이름 | 타입 |
|---|---|
ids | any[] |
options? | GetByIdsOptions |
반환
Promise<Get2SpacesResponse>
정의된 위치
getPosts
id, options): Promise<Response>
Space 포스트 가져오기
특정 Space에서 공유된 포스트 목록을 해당 Space의 ID를 사용해 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
id | string | 조회할 Space의 ID입니다. |
options | GetPostsOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원본 Response를 그대로 반환합니다
정의 위치
spaces/client.ts:572 ▸ getPosts(id, options?): Promise<Get2SpacesIdTweetsResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
options? | GetPostsOptions |
반환값
Promise<Get2SpacesIdTweetsResponse>
정의된 위치
search
query, options): Promise<Response>
Spaces 검색
지정된 검색 쿼리와 일치하는 Spaces의 리스트를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
query | string | 검색에 사용할 쿼리입니다. |
options | SearchOptions & { requestOptions: { raw: true } } | - |
반환
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의된 위치
query, options?): Promise<Get2SpacesSearchResponse>
매개변수
| 이름 | type |
|---|---|
query | string |
options? | SearchOptions |
반환값
Promise<Get2SpacesSearchResponse>
정의된 위치
getBuyers
id, options): Promise<Response>
스페이스 티켓 구매자 가져오기
특정 스페이스의 ID를 사용해 해당 스페이스의 티켓을 구매한 사용자들의 목록을 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 가져올 Space의 ID입니다. |
options | GetBuyersOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원본 Response입니다
정의 위치
spaces/client.ts:1080 ▸ getBuyers(id, options?): Promise<Get2SpacesIdBuyersResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
options? | GetBuyersOptions |
반환값
Promise<Get2SpacesIdBuyersResponse>
정의 위치
spaces/client.ts:1093getById
id, options): Promise<Response>
ID로 Space 조회하기
특정 Space를 ID로 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
id | string | 조회할 Space의 ID입니다. |
options | GetByIdOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response 객체
정의 위치
spaces/client.ts:1293 ▸ getById(id, options?): Promise<Get2SpacesIdResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
options? | GetByIdOptions |
반환값
Promise<Get2SpacesIdResponse>
정의된 위치
getByCreatorIds
userIds, options): Promise<Response>
생성자 ID로 Spaces 가져오기
지정된 User ID가 생성한 Spaces의 세부 정보를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
userIds | any[] | 검색 대상 사용자들의 id입니다. |
options | GetByCreatorIdsOptions & { requestOptions: { raw: true } } | - |
반환
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw 가 true 인 경우 원본 Response
정의 위치
spaces/client.ts:1495 ▸ getByCreatorIds(userIds, options?): Promise<Get2SpacesByCreatorIdsResponse>
매개변수
| 이름 | 타입 |
|---|---|
userIds | any[] |
options? | GetByCreatorIdsOptions |
반환 값
Promise<Get2SpacesByCreatorIdsResponse>