コンストラクタ
constructor
client): WebhooksClient
新しい Webhooks クライアント インスタンスを作成します
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
client | Client | X API のメインクライアントインスタンス |
戻り値
WebhooksClient
定義箇所
メソッド
getStreamLinks
Promise<WebhookLinksGetResponse>
ストリームリンクを取得
フィルタ済みストリームのルールセットに関連付けられた Webhook リンクの一覧を取得します。
返り値
Promise<WebhookLinksGetResponse>
API レスポンスで解決される Promise
定義箇所
createStreamLink
webhookId, options?): Promise<WebhookLinksCreateResponse>
ストリームリンクを作成
指定した webhook に FilteredStream イベントを配信するためのリンクを作成します。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
webhookId | string | FilteredStream のルールセットにリンクする webhook のid。 |
options | CreateStreamLinkOptions | - |
戻り値
Promise<WebhookLinksCreateResponse>
API レスポンスで解決される Promise
定義場所
webhooks/client.ts:145deleteStreamLink
webhookId): Promise<WebhookLinksDeleteResponse>
ストリームリンクを削除
FilteredStream のイベントから、指定した webhook へのリンクを削除します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
webhookId | string | FilteredStream のルールセットにリンクする webhook の id。 |
戻り値
Promise<WebhookLinksDeleteResponse>
API レスポンスに解決される Promise
定義先
webhooks/client.ts:225validate
webhookId): Promise<WebhookConfigPutResponse>
Webhook を検証します
指定した Webhook に対して CRC チェックを実行します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
webhookId | string | 確認対象の webhook の id。 |
戻り値
Promise<WebhookConfigPutResponse>
API レスポンスに解決される Promise
定義先
webhooks/client.ts:263delete
webhookId): Promise<WebhookConfigDeleteResponse>
Webhook の削除
既存の Webhook 設定を削除します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
webhookId | string | 削除するWebhookのid。 |
返り値
Promise<WebhookConfigDeleteResponse>
API レスポンスで解決される Promise
定義場所
webhooks/client.ts:301get
options?): Promise<Get2WebhooksResponse>
Webhook の取得
クライアントの App に関連付けられている webhook 設定の一覧を取得します。
パラメーター
| 名称 | 型 |
|---|---|
options | GetOptions |
戻り値
Promise<Get2WebhooksResponse>
API レスポンスを返す Promise
定義箇所
create
options?): Promise<WebhookConfigCreateResponse>
Webhook の作成
新しい Webhook 構成を作成します。
パラメータ
| 名前 | 型 |
|---|---|
options | CreateOptions |
戻り値
Promise<WebhookConfigCreateResponse>
API レスポンスに解決される Promise