메인 콘텐츠로 건너뛰기
Activity 작업용 Client 이 Client는 X API의 Activity endpoint와 상호작용하기 위한 메서드를 제공합니다. Activity 관련 모든 작업에 대해 인증, 요청 포맷 구성, 응답 파싱을 처리합니다.

생성자

constructor

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

매개변수

이름type설명
clientClient주요 X API Client 인스턴스

반환값

ActivityClient

정의 위치

activity/client.ts:118

메서드

getSubscriptions

getSubscriptions(options): Promise<Response> X 활동 구독 정보 가져오기 XAA에 대한 활성 구독 목록을 가져옵니다

매개변수

이름type
optionsObject
options.requestOptionsObject
options.requestOptions.rawtrue

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.rawtrue인 경우 원시 Response

정의된 위치

activity/client.ts:159 getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

반환값

Promise<ActivitySubscriptionGetResponse>

정의된 위치

activity/client.ts:168

createSubscription

createSubscription(options): Promise<Response> X activity 구독 생성 X activity 이벤트 구독을 생성합니다

매개변수

이름type
optionsCreateSubscriptionOptions & { requestOptions: { raw: true } }

반환값

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

정의된 위치

activity/client.ts:237 createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

매개변수

이름Type
options?CreateSubscriptionOptions

반환값

Promise<ActivitySubscriptionCreateResponse>

정의된 위치

activity/client.ts:246

stream

stream(options): Promise<Response> 활동 스트림 X 활동의 스트림

매개변수

이름type
optionsStreamOptions & { requestOptions: { raw: true } }

Returns

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

정의 위치

activity/client.ts:332 stream(options?): Promise<ActivityStreamingResponse>

매개변수

이름type
options?StreamOptions

반환

Promise<ActivityStreamingResponse>

정의된 곳

activity/client.ts:341

updateSubscription

updateSubscription(subscriptionId, options): Promise<Response> X 활동 구독 업데이트 X 활동 이벤트 구독을 업데이트합니다

매개변수

NameType설명
subscriptionIdstring업데이트할 구독의 식별자입니다.
optionsUpdateSubscriptionOptions & { requestOptions: { raw: true } }-

반환값

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

정의 위치

activity/client.ts:487 updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>

매개변수

이름타입
subscriptionIdstring
options?UpdateSubscriptionOptions

반환 값

Promise<ActivitySubscriptionUpdateResponse>

정의된 위치

activity/client.ts:500

deleteSubscription

deleteSubscription(subscriptionId, options): Promise<Response> X 활동 구독을 삭제합니다 X 활동 이벤트용 구독을 삭제합니다

매개변수

NameTypeDescription
subscriptionIdstring삭제할 구독의 ID입니다.
optionsObject-
options.requestOptionsObject-
options.requestOptions.rawtrue-

반환값

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

정의 위치

activity/client.ts:602 deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

매개변수

이름타입
subscriptionIdstring

반환값

Promise<ActivitySubscriptionDeleteResponse>

정의 위치

activity/client.ts:615