REST.Client.TBodyParams.Add

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

class procedure Add(const AParams: TRESTRequestParameterList; const ABodyContent: string; AContentType: TRESTContentType = ctNone); overload; static;
class procedure Add<T: class, constructor>(const AParams: TRESTRequestParameterList; const AObject: T); overload; static;
class procedure Add(const AParams: TRESTRequestParameterList; const AObject: TJsonObject); overload; static;
class procedure Add(const AParams: TRESTRequestParameterList; const ABodyContent: TStream; AContentType: TRESTContentType = ctNone); overload; static;

C++

static void __fastcall Add(TRESTRequestParameterList* const AParams, const System::UnicodeString ABodyContent, Rest::Types::TRESTContentType AContentType = (Rest::Types::TRESTContentType)(0x0))/* overload */;
template<typename T> static void __fastcall Add(TRESTRequestParameterList* const AParams, const T AObject)/* overload */;
static void __fastcall Add(TRESTRequestParameterList* const AParams, System::Json::TJSONObject* const AObject)/* overload */;
static void __fastcall Add(TRESTRequestParameterList* const AParams, System::Classes::TStream* const ABodyContent, Rest::Types::TRESTContentType AContentType = (Rest::Types::TRESTContentType)(0x0))/* overload */;

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
REST.Client.pas
REST.Client.hpp
REST.Client TBodyParams


説明

指定された内容を、指定された REST 要求パラメータ リスト本体パラメータとして追加します。

AParams に追加する本体パラメータの値を指定する方法は次の 4 とおりあります。

  • ABodyContent文字列またはストリームの場合、Add では、指定されたコンテンツ タイプの指定の内容を要求の本体パラメータとして使用します。
  • AObjectTJSONObject のインスタンスまたは指定された型のオブジェクトである場合、Add では、指定されたオブジェクトを JSON としてシリアル化し、そのシリアル化されたデータを要求の本体パラメータの値として使用します。

通常、Add を呼び出すと、本体パラメータの前の値が置き換えられます。ただし、ABodyContent を文字列として渡す場合は、指定した値が付け加えられ、結果として生成される要求には複数の本体パラメータが含まれています。それぞれの本体パラメータの名前は、"body" の後にランダムな GUID が付いたものになります。

関連項目