TsgcHTTP3Client › メソッド › RequestOptions

RequestOptions メソッド

同期 HTTP/3 OPTIONS リクエストを送信し、レスポンスボディを返します。

構文

function RequestOptions(const aURL: string): string; overload;
procedure RequestOptions(const aURL: string; const aResponseContent: TStream); overload;

パラメータ

名前タイプ説明
aURLconst stringOPTIONS リクエストの送信先の絶対 URL。
aResponseContentTStream生のレスポンスボディを受け取るストリーム(ストリームオーバーロードのみ)。

戻り値

サーバーから受信したレスポンスボディ(文字列としてデコード済み)。ストリームオーバーロードは代わりに aResponseContent にボディを書き込みます。(string)

解説

RequestOptions は HTTP OPTIONS リクエストを発行します。これはリソースに利用可能な通信オプション(サポートするメソッド(allow ヘッダーで報告)やクロスオリジンリクエストの CORS ポリシーなど)を検出するために使用されます。この呼び出しは完全な HTTP/3 レスポンスを受信するまでブロックします。このメソッドはコンポーネントの Options プロパティと名前が衝突しないよう、Options ではなく RequestOptions という名前になっています。ノンブロッキングリクエストには OptionsAsync を使用してください。返信は OnResponse で通知されます。

使用例


vResponse := oClient.RequestOptions('https://api.example.com/v1/users');

メソッドに戻る