메인 콘텐츠로 건너뛰기
Spaces 관련 작업용 Client 이 Client는 X API의 Spaces 엔드포인트와 상호작용하기 위한 메서드를 제공합니다. 인증, 요청 포맷팅, 응답 파싱을 처리하여 Spaces와 관련된 모든 작업을 간편하게 수행할 수 있게 해줍니다.

생성자

constructor

new SpacesClient(client): SpacesClient 새로운 SpacesClient 인스턴스를 생성합니다

매개변수

이름타입설명
clientClient주 X API Client 인스턴스

반환

SpacesClient

정의된 위치

spaces/client.ts:316

메서드

getByIds

getByIds(ids, options): Promise<Response> ID로 Spaces 조회 여러 개의 Space에 대한 세부 정보를 해당 ID로 조회합니다.

매개변수

NameTypeDescription
idsany[]반환할 Space ID 목록입니다.
optionsGetByIdsOptions & { requestOptions: { raw: true } }-

반환값

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

정의 위치

spaces/client.ts:361 getByIds(ids, options?): Promise<Get2SpacesResponse>

매개변수

이름타입
idsany[]
options?GetByIdsOptions

반환

Promise<Get2SpacesResponse>

정의된 위치

spaces/client.ts:374

getPosts

getPosts(id, options): Promise<Response> Space 포스트 가져오기 특정 Space에서 공유된 포스트 목록을 해당 Space의 ID를 사용해 조회합니다.

매개변수

NameTypeDescription
idstring조회할 Space의 ID입니다.
optionsGetPostsOptions & { requestOptions: { raw: true } }-

반환값

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

정의 위치

spaces/client.ts:572 getPosts(id, options?): Promise<Get2SpacesIdTweetsResponse>

매개변수

이름타입
idstring
options?GetPostsOptions

반환값

Promise<Get2SpacesIdTweetsResponse>

정의된 위치

spaces/client.ts:585
search(query, options): Promise<Response> Spaces 검색 지정된 검색 쿼리와 일치하는 Spaces의 리스트를 조회합니다.

매개변수

NameTypeDescription
querystring검색에 사용할 쿼리입니다.
optionsSearchOptions & { requestOptions: { raw: true } }-

반환

Promise<Response> API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response

정의된 위치

spaces/client.ts:835 search(query, options?): Promise<Get2SpacesSearchResponse>

매개변수

이름type
querystring
options?SearchOptions

반환값

Promise<Get2SpacesSearchResponse>

정의된 위치

spaces/client.ts:848

getBuyers

getBuyers(id, options): Promise<Response> 스페이스 티켓 구매자 가져오기 특정 스페이스의 ID를 사용해 해당 스페이스의 티켓을 구매한 사용자들의 목록을 조회합니다.

매개변수

이름타입설명
idstring가져올 Space의 ID입니다.
optionsGetBuyersOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원본 Response입니다

정의 위치

spaces/client.ts:1080 getBuyers(id, options?): Promise<Get2SpacesIdBuyersResponse>

매개변수

이름타입
idstring
options?GetBuyersOptions

반환값

Promise<Get2SpacesIdBuyersResponse>

정의 위치

spaces/client.ts:1093

getById

getById(id, options): Promise<Response> ID로 Space 조회하기 특정 Space를 ID로 조회합니다.

매개변수

NameTypeDescription
idstring조회할 Space의 ID입니다.
optionsGetByIdOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise 또는 requestOptions.rawtrue인 경우 원시 Response 객체

정의 위치

spaces/client.ts:1293 getById(id, options?): Promise<Get2SpacesIdResponse>

매개변수

이름타입
idstring
options?GetByIdOptions

반환값

Promise<Get2SpacesIdResponse>

정의된 위치

spaces/client.ts:1306

getByCreatorIds

getByCreatorIds(userIds, options): Promise<Response> 생성자 ID로 Spaces 가져오기 지정된 User ID가 생성한 Spaces의 세부 정보를 조회합니다.

매개변수

NameTypeDescription
userIdsany[]검색 대상 사용자들의 id입니다.
optionsGetByCreatorIdsOptions & { requestOptions: { raw: true } }-

반환

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

정의 위치

spaces/client.ts:1495 getByCreatorIds(userIds, options?): Promise<Get2SpacesByCreatorIdsResponse>

매개변수

이름타입
userIdsany[]
options?GetByCreatorIdsOptions

반환 값

Promise<Get2SpacesByCreatorIdsResponse>

정의된 위치

spaces/client.ts:1508