REST.Backend.EMSApi.TEMSClientAPI.DoAddAuthParameters

De RAD Studio API Documentation
Aller à : navigation, rechercher

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 */;

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
protected
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI


Description

Ajoute les données d'authentification configurées aux en-têtes de la requête spécifiée.

DoAddAuthParameters accepte les paramètres suivants :

  • AAuthentication : facultatif. Le type du paramètre d'authentification à ajouter.
  • ARequest : facultatif. La requête à laquelle le paramètre est ajouté.

Si vous ne spécifiez pas AAuthentication, cette méthode utilise la valeur renvoyée par GetActualAuthentication. Si vous ne spécifiez pas ARequest, la méthode utilise la valeur de la propriété Request. Toutefois, la méthode qui vous laisse spécifier le paramètre ARequest uniquement est AddAuthParameters.

AddAuthParameters appelle DoAddAuthParameters.

Exceptions

Exception Message Description

EEMSClientAPIError

MasterSecret requis

Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide.

Token de session requis

Authentication a la valeur TAuthentication.Session, et vous ne vous êtes pas connecté ou le token d'authentification de session fourni lors de la connexion est une chaîne vide.

Voir aussi