TTMSFNCRESTClientRequest Class
Contains the URL, headers, authorization, payload, and result settings for one HTTP request.
API unit family: TMSFNCRESTClient
Inherits from: TPersistent
Syntax
TTMSFNCRESTClientRequest = class(TPersistent)
Properties
| Name | Description |
|---|---|
| Async | Gets or sets whether the request runs asynchronously. |
| AuthorizationOptions | Gets or sets the authorization options applied to the request. |
| Headers | Gets or sets the HTTP headers sent with the request. |
| Host | Gets or sets the server host for the request. |
| Method | Gets or sets the HTTP method used by the request. |
| Owner | Gets the object that owns the request configuration. |
| Path | Gets or sets the path portion of the request URL. |
| Port | Gets or sets the target port. |
| PostData | Gets or sets the body sent with methods that support payload data. |
| Query | Gets or sets the query string. |
| QueryParameters | Gets or sets the collection of query-string parameters. |
| ResultFile | Gets or sets the target file path for file-based responses. |
| ResultType | Gets or sets how the response body is returned. |
| URL | Gets or sets the complete request URL. |
Methods
| Name | Description |
|---|---|
| Clear | Resets the request settings to their defaults. |
| ExecuteRequest | Executes the request and returns the tracked request entry. |
| ExecuteRequestWithResultFile | Executes the request and writes the response to a file. |
| ExecuteRequestWithResultStream | Executes the request and reads the response into a stream. |
| ExecuteRequestWithResultString | Executes the request and reads the response as text. |
| GetMethodString | Returns the request method as text. |