REST.Backend.EMSApi.TEMSClientAPI.DoAddAuthParameters
Delphi
procedure DoAddAuthParameters; overload;
procedure DoAddAuthParameters(AAuthentication: TAuthentication); overload;
procedure DoAddAuthParameters(const ARequest: TCustomRESTRequest; AAuthentication: TAuthentication); overload;
C++
void __fastcall DoAddAuthParameters()/* overload */;
void __fastcall DoAddAuthParameters(TAuthentication AAuthentication)/* overload */;
void __fastcall DoAddAuthParameters(Rest::Client::TCustomRESTRequest* const ARequest, TAuthentication AAuthentication)/* overload */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
protected | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
構成された認証データを、指定された要求のヘッダーに追加します。
DoAddAuthParameters は次のパラメータを受け取ります。
AAuthentication： 任意指定です。追加する認証パラメータの種類。ARequest： 任意指定です。パラメータの追加先となる要求。
AAuthentication を指定しない場合、このメソッドでは、GetActualAuthentication の戻り値が使用されます。ARequest を指定しない場合、このメソッドでは、Request プロパティの値が使用されます。ただし、ARequest パラメータだけを指定できるメソッドは AddAuthParameters です。
AddAuthParameters から DoAddAuthParameters が呼び出されます。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
|
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |