Delete メソッド

オーバーロード 1

構文

function Delete(const aURL: string): string;

パラメータ

名前	タイプ	説明
aURL	const string	サーバー上で削除するリソースの絶対URL。

戻り値

レスポンスボディ（多くの場合、JSON ステータスドキュメント）を文字列としてデコードしたもの。（string）

解説

DELETE リクエストは通常、ボディを持ちません。成功した呼び出しは、サーバーによって空の文字列とともに 204 No Content、または確認ドキュメントとともに 200 OK を返します。

使用例

vResponse := oClient.Delete('https://api.example.com/users/42');

オーバーロード 2

構文

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

パラメータ

名前	タイプ	説明
aURL	const string	サーバー上で削除するリソースの絶対URL。
aResponseContent	const TStream	サーバーのレスポンスボディをそのまま収集するストリーム。

解説

レスポンスを呼び出し元が提供するTStreamにキャプチャするストリームベースのバリアント。削除レスポンスが大きい場合や、ディスクに直接永続化する必要がある場合は、このオーバーロードを選択してください。

使用例

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