TsgcHTTP2ClientMethoden › Options

Options Methode

Voert een synchrone HTTP/2 OPTIONS-aanvraag uit om de communicatieopties van een bron te ontdekken.

Overloads

Overload 1

Syntaxis

function Options(const aURL: string): string;

Parameters

NaamTypeBeschrijving
aURLconst stringAbsolute URL van de resource waarvan de mogelijkheden worden bevraagd, of * om de server als geheel te bevragen.

Retourwaarde

Responsbody die door de server als tekenreeks is geretourneerd; de nuttige informatie bevindt zich gewoonlijk in de antwoordheaders. (string)

Opmerkingen

OPTIONS wordt gewoonlijk gebruikt door browsers voor CORS-preflight en door clients om te onderzoeken welke methoden worden geaccepteerd. Inspecteer Request.Headers na de aanroep om de kopteksten allow, access-control-allow-* en verwante te lezen.

Voorbeeld

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

Overload 2

Syntaxis

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

Parameters

NaamTypeBeschrijving
aURLconst stringAbsolute URL van de resource die wordt ondervraagd.
aResponseContentconst TStreamDoor de aanroeper beheerde stream die de antwoordbody ontvangt, als de server er een retourneert.

Opmerkingen

Op stream gebaseerde variant van OPTIONS. Gebruik dit wanneer de responsepayload moet worden doorgestuurd naar een willekeurige TStream in plaats van als tekenreeks te worden gerealiseerd.

Voorbeeld

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

Terug naar methoden