ConnectionsClient

connections に関する各種操作を行うための Client

この Client は、X API の connections エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストの整形、レスポンスの解析を行い、connections に関連するすべての操作を処理します。

​

コンストラクタ

​

constructor

• new ConnectionsClient(client): ConnectionsClient

新しい ConnectionsClient インスタンスを作成します

​

パラメーター

Name	Type	Description
client	Client	メインとなる X API の Client インスタンス

​

戻り値

ConnectionsClient

​

定義場所

connections/client.ts:88

​

メソッド

​

getConnectionHistory

▸ getConnectionHistory(options): Promise<Response>

接続履歴の取得
認証済みアプリケーションに対する現在および過去のストリーミング接続と、その切断理由を返します。

​

パラメータ

パラメータ名	型
options	GetConnectionHistoryOptions & { requestOptions: { raw: true } }

​

Returns

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response を解決する Promise

​

定義場所

connections/client.ts:129

▸ getConnectionHistory(options?): Promise<Get2ConnectionsResponse>

​

パラメーター

名前	型
options?	GetConnectionHistoryOptions

​

戻り値

Promise<Get2ConnectionsResponse>

​

定義場所

connections/client.ts:138

---

​

deleteAll

▸ deleteAll(options): Promise<Response>

すべての接続を終了します
認証された App のアクティブなストリーミング接続をすべて終了します。

​

パラメータ

名前	型
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

​

Returns

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

​

定義場所

connections/client.ts:318

▸ deleteAll(): Promise<KillAllConnectionsResponse>

​

戻り値

Promise<KillAllConnectionsResponse>

​

定義元

connections/client.ts:327