생성자
constructor
client): ActivityClient
새로운 ActivityClient 인스턴스를 생성합니다
매개변수
| 이름 | type | 설명 |
|---|---|---|
client | Client | 주요 X API Client 인스턴스 |
반환값
ActivityClient
정의 위치
activity/client.ts:118메서드
getSubscriptions
options): Promise<Response>
X 활동 구독 정보 가져오기
XAA에 대한 활성 구독 목록을 가져옵니다
매개변수
| 이름 | type |
|---|---|
options | Object |
options.requestOptions | Object |
options.requestOptions.raw | true |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response
정의된 위치
Promise<ActivitySubscriptionGetResponse>
반환값
Promise<ActivitySubscriptionGetResponse>
정의된 위치
createSubscription
options): Promise<Response>
X activity 구독 생성
X activity 이벤트 구독을 생성합니다
매개변수
| 이름 | type |
|---|---|
options | CreateSubscriptionOptions & { requestOptions: { raw: true } } |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise. 단, requestOptions.raw 가 true 인 경우 원시 Response 를 반환합니다
정의된 위치
options?): Promise<ActivitySubscriptionCreateResponse>
매개변수
| 이름 | Type |
|---|---|
options? | CreateSubscriptionOptions |
반환값
Promise<ActivitySubscriptionCreateResponse>
정의된 위치
stream
options): Promise<Response>
활동 스트림
X 활동의 스트림
매개변수
| 이름 | type |
|---|---|
options | StreamOptions & { 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:341updateSubscription
subscriptionId, options): Promise<Response>
X 활동 구독 업데이트
X 활동 이벤트 구독을 업데이트합니다
매개변수
| Name | Type | 설명 |
|---|---|---|
subscriptionId | string | 업데이트할 구독의 식별자입니다. |
options | UpdateSubscriptionOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원본 Response
정의 위치
activity/client.ts:487 ▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>
매개변수
| 이름 | 타입 |
|---|---|
subscriptionId | string |
options? | UpdateSubscriptionOptions |
반환 값
Promise<ActivitySubscriptionUpdateResponse>
정의된 위치
deleteSubscription
subscriptionId, options): Promise<Response>
X 활동 구독을 삭제합니다
X 활동 이벤트용 구독을 삭제합니다
매개변수
| Name | Type | Description |
|---|---|---|
subscriptionId | string | 삭제할 구독의 ID입니다. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response입니다.
정의 위치
activity/client.ts:602 ▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>
매개변수
| 이름 | 타입 |
|---|---|
subscriptionId | string |
반환값
Promise<ActivitySubscriptionDeleteResponse>