Table of Contents

TTMSFNCRESTClient Class

Component for configuring, executing, and inspecting HTTP REST requests.

API unit family: TMSFNCRESTClient Inherits from: TTMSFNCCustomRESTClient

Syntax

TTMSFNCRESTClient = class(TTMSFNCCustomRESTClient)

Properties

Name Description
ExecutedRequests Gets or sets the executed request history. (inherited from TTMSFNCCustomRESTClient)
Request Gets or sets the request configuration used by the client. (inherited from TTMSFNCCustomRESTClient)
Version Gets the component version string. (inherited from TTMSFNCCustomRESTClient)

Methods

Name Description
Clear Clears the current request and the executed request history. (inherited from TTMSFNCCustomRESTClient)
ExecuteRequest Executes the configured request and returns the tracked request entry. (inherited from TTMSFNCCustomRESTClient)
ExecuteRequestWithResultFile Executes the configured request and writes the response to a file. (inherited from TTMSFNCCustomRESTClient)
ExecuteRequestWithResultStream Executes the configured request and reads the response into a stream. (inherited from TTMSFNCCustomRESTClient)
ExecuteRequestWithResultString Executes the configured request and reads the response as text. (inherited from TTMSFNCCustomRESTClient)
GetExecutedRequestByURL Returns the most recent executed request with the specified URL. (inherited from TTMSFNCCustomRESTClient)
LoadRequest Loads a saved request definition. (inherited from TTMSFNCCustomRESTClient)

Events

Name Description
OnExecuteRequest Fires before the low-level request is executed. (inherited from TTMSFNCCustomRESTClient)
OnRequestHeadersChanged Fires when request headers change. (inherited from TTMSFNCCustomRESTClient)
OnRequestResponseFileRetrieved Fires after a file response is retrieved. (inherited from TTMSFNCCustomRESTClient)
OnRequestResponseRetrieved Fires after a response is retrieved with all response targets available. (inherited from TTMSFNCCustomRESTClient)
OnRequestResponseStreamRetrieved Fires after a stream response is retrieved. (inherited from TTMSFNCCustomRESTClient)
OnRequestResponseStringRetrieved Fires after a text response is retrieved. (inherited from TTMSFNCCustomRESTClient)
OnRequestURLChanged Fires when the request URL changes and allows the URL to be adjusted. (inherited from TTMSFNCCustomRESTClient)

Used by