생성자
constructor
client): AccountActivityClient
새 계정 활동 클라이언트 인스턴스를 생성합니다
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
client | Client | 주요 X API 클라이언트 인스턴스 |
반환값
AccountActivityClient
정의됨
account_activity/client.ts:54메서드
getSubscriptions
webhookId): Promise<SubscriptionsListGetResponse>
구독 가져오기
지정된 webhook의 활성 구독 목록을 반환합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
webhookId | string | 구독을 가져올 웹훅 id입니다. |
반환
Promise<SubscriptionsListGetResponse>
API 응답으로 이행되는 Promise
정의된 위치
createReplayJob
webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>
리플레이 작업 생성
지정된 webhook에 연결된 모든 구독에 대해, 최대 지난 5일치 활동을 재수집하기 위한 리플레이 작업을 생성합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
webhookId | string | 웹훅 구성의 고유 식별자입니다. |
fromDate | string | 이벤트 제공 시작 시점에 해당하는 가장 이른 UTC 타임스탬프(포함)로, yyyymmddhhmm 형식입니다. |
toDate | string | 이벤트 제공 종료 시점에 해당하는 가장 늦은 UTC 타임스탬프(미포함)로, yyyymmddhhmm 형식입니다. |
반환
Promise<ReplayJobCreateResponse>
API 응답으로 resolve되는 Promise
정의됨
account_activity/client.ts:118validateSubscription
webhookId): Promise<SubscriptionsGetResponse>
구독 유효성 검사
지정된 webhook에 대해 사용자의 Account Activity 구독 상태를 확인합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
webhookId | string | 구독 여부를 확인할 웹훅 id입니다. |
반환
Promise<SubscriptionsGetResponse>
API 응답으로 resolve되는 Promise
정의된 위치
createSubscription
webhookId, options?): Promise<SubscriptionsCreateResponse>
구독 생성
지정된 webhook과 사용자에 대해 Account Activity 구독을 생성합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
webhookId | string | 구독과 대조할 웹훅 id입니다. |
options | CreateSubscriptionOptions | - |
반환
Promise<SubscriptionsCreateResponse>
API 응답으로 resolve되는 Promise
정의된 위치
deleteSubscription
webhookId, userId): Promise<SubscriptionsDeleteResponse>
구독 삭제
지정된 webhook과 사용자 id에 대한 Account Activity 구독을 삭제합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
webhookId | string | 구독 여부를 확인할 대상 webhook의 id입니다. |
userId | string | 구독 해지할 대상 사용자 id입니다. |
반환값
Promise<SubscriptionsDeleteResponse>
API 응답으로 resolve되는 Promise
정의 위치
account_activity/client.ts:261getSubscriptionCount
Promise<SubscriptionsCountGetResponse>
구독 수 가져오기
현재 활성 상태인 Account Activity 구독의 수를 조회합니다.
반환
Promise<SubscriptionsCountGetResponse>
API 응답으로 resolve되는 Promise