Options メソッド

オーバーロード 1

構文

function Options(const aURL: string): string;

パラメータ

名前	タイプ	説明
aURL	const string	機能がクエリされているリソースの絶対URL、またはサーバー全体をクエリする場合は *。

戻り値

サーバーが返す文字列としてのレスポンスボディ。有用な情報は通常レスポンスヘッダーにあります。（string）

解説

OPTIONSは、ブラウザーがCORSプリフライトで、またクライアントがどのメソッドが受け入れられるかをプローブするために一般的に使用されます。呼び出し後にRequest.Headersを検査して、allow、access-control-allow-*および関連するヘッダーを読み取ってください。

使用例

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

オーバーロード 2

構文

procedure Options(Const aURL: string; const aResponseContent: TStream);

パラメータ

名前	タイプ	説明
aURL	const string	照会するリソースの絶対 URL。
aResponseContent	const TStream	サーバーが返した場合にレスポンスボディを受け取る呼び出し元所有のストリーム。

解説

OPTIONS のストリームベース バリアント。レスポンス ペイロードを文字列としてマテリアライズするのではなく、任意の TStream にルーティングする場合に使用します。

使用例

oOut := TMemoryStream.Create;
try
  oClient.Options('https://api.example.com/v1/users', oOut);
finally
  oOut.Free;
end;