メインコンテンツへスキップ
一般機能向けクライアント このクライアントは、X API の一般系エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストのフォーマット、レスポンスのパースを担当し、一般機能に関連するあらゆる操作を扱います。

コンストラクタ

constructor

new GeneralClient(client): GeneralClient 新しい汎用クライアントのインスタンスを作成します

パラメータ

名前説明
clientClientX API のメインクライアントインスタンス

戻り値

GeneralClient

定義場所

general/client.ts:33

メソッド

getOpenApiSpec

getOpenApiSpec(): Promise<GetOpenApiSpecResponse> OpenAPI 仕様を取得します。 OpenAPI 仕様の完全版を JSON 形式で取得します(https://github.com/OAI/OpenAPI-Specification/blob/master/README.md を参照)。

返却値

Promise<GetOpenApiSpecResponse> API レスポンスで解決される Promise

定義場所

general/client.ts:46