생성자
constructor
client): WebhooksClient
새로운 웹훅 클라이언트 인스턴스를 생성합니다
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
client | Client | X API의 주요 클라이언트 인스턴스 |
반환
WebhooksClient
정의됨
webhooks/client.ts:96메서드
getStreamLinks
Promise<WebhookLinksGetResponse>
스트림 링크 가져오기
필터링된 스트림 규칙 세트와 연결된 웹훅 링크 목록을 가져옵니다.
반환값
Promise<WebhookLinksGetResponse>
API 응답을 반환하는 Promise
정의된 위치
createStreamLink
webhookId, options?): Promise<WebhookLinksCreateResponse>
스트림 링크 생성
지정된 웹훅에 FilteredStream 이벤트를 전달하기 위한 링크를 생성합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
webhookId | string | FilteredStream 규칙 세트에 연결할 웹훅 ID입니다. |
options | CreateStreamLinkOptions | - |
반환값
Promise<WebhookLinksCreateResponse>
API 응답을 반환하는 Promise
정의된 위치
deleteStreamLink
webhookId): Promise<WebhookLinksDeleteResponse>
스트림 링크 삭제
FilteredStream 이벤트와 지정된 웹훅 간의 링크를 삭제합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
webhookId | string | FilteredStream 규칙 세트에 연결할 웹훅의 ID입니다. |
반환
Promise<WebhookLinksDeleteResponse>
API 응답으로 해결되는 Promise
정의 위치
webhooks/client.ts:225validate
webhookId): Promise<WebhookConfigPutResponse>
웹훅 검증
주어진 웹훅에 대한 CRC 검사를 트리거합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
webhookId | string | 확인할 웹훅의 ID. |
반환
Promise<WebhookConfigPutResponse>
API 응답으로 해결되는 Promise
정의된 위치
delete
webhookId): Promise<WebhookConfigDeleteResponse>
웹훅 삭제
기존 웹훅 구성을 삭제합니다.
매개변수
| Name | Type | Description |
|---|---|---|
webhookId | string | 삭제할 웹훅의 ID. |
반환값
Promise<WebhookConfigDeleteResponse>
API 응답으로 해결되는 Promise
정의 위치
webhooks/client.ts:301get
options?): Promise<Get2WebhooksResponse>
Webhook 조회
클라이언트 App에 연결된 webhook 구성 목록을 조회합니다.
매개변수
| 이름 | 유형 |
|---|---|
options | GetOptions |
반환
Promise<Get2WebhooksResponse>
API 응답으로 resolve되는 Promise
정의 위치
webhooks/client.ts:335create
options?): Promise<WebhookConfigCreateResponse>
웹훅 생성
새로운 웹훅 설정을 생성합니다.
매개변수
| 이름 | 타입 |
|---|---|
options | CreateOptions |
반환
Promise<WebhookConfigCreateResponse>
API 응답으로 해결되는 Promise