TTMSMCPCloudBase Class
Drop-in cloud base component that exposes HTTP request execution, logging, and event hooks for direct use in the IDE.
API unit family: TMS.MCP.CloudBase
Inherits from: TTMSMCPCustomCloudBase
Syntax
TTMSMCPCloudBase = class(TTMSMCPCustomCloudBase)
Properties
Name
Description
LogFileName Full path to the file where request and response details are logged when Logging is enabled. (inherited from TTMSMCPCustomCloudBase)
Logging When True, HTTP request and response details are written to the log file. (inherited from TTMSMCPCustomCloudBase)
PostDataBuilder The shared POST body builder used to construct multipart or URL-encoded request bodies. (inherited from TTMSMCPCustomCloudBase)
Request The template request object whose parameters are used when creating new requests via AddRequest or ExecuteRequest. (inherited from TTMSMCPCustomCloudBase)
RequestResult The result object from the most recently executed request. (inherited from TTMSMCPCustomCloudBase)
RunningRequests The collection of request result objects for all currently executing requests. (inherited from TTMSMCPCustomCloudBase)
Scopes The list of OAuth or API permission scopes requested from the service. (inherited from TTMSMCPCustomCloudBase)
Version Version string of the cloud base component. (inherited from TTMSMCPCustomCloudBase)
Methods
Name
Description
AddRequest Adds a new request to the queue and returns the result object without executing it immediately. (inherited from TTMSMCPCustomCloudBase)
CancelRequest Cancels a specific running request. (inherited from TTMSMCPCustomCloudBase)
CancelRequests Cancels all currently running requests. (inherited from TTMSMCPCustomCloudBase)
Curl Executes a cURL command string and delivers the full request result via the callback. (inherited from TTMSMCPCustomCloudBase)
DownloadFileFromURL Downloads a file from the specified URL and delivers the result via the callback. (inherited from TTMSMCPCustomCloudBase)
ExecuteAllRequests Executes all queued requests that have not yet started. (inherited from TTMSMCPCustomCloudBase)
ExecuteRequest Executes the current Request immediately and returns the result object. (inherited from TTMSMCPCustomCloudBase)
GetRequestCount Returns the number of requests matching the specified filter criteria. (inherited from TTMSMCPCustomCloudBase)
GetUploadFileSize Returns the total size in bytes of the file to be uploaded for the given request. (inherited from TTMSMCPCustomCloudBase)
SimpleGETAsyncAsStream Sends an asynchronous HTTP GET request and delivers the response body as a memory stream via the callback. (inherited from TTMSMCPCustomCloudBase)
SimpleGETAsyncAsString Sends an asynchronous HTTP GET request and delivers the response body as a string via the callback. (inherited from TTMSMCPCustomCloudBase)
SimpleGETSyncAsStream Sends a synchronous HTTP GET request and returns the response body as a memory stream. (inherited from TTMSMCPCustomCloudBase)
SimpleGETSyncAsString Sends a synchronous HTTP GET request and returns the response body as a string. (inherited from TTMSMCPCustomCloudBase)
Test Runs a connectivity or authorization test against the configured service endpoint. (inherited from TTMSMCPCustomCloudBase)
Events
Name
Description
OnRequestCancelled Fires when an HTTP request is cancelled before it completes. (inherited from TTMSMCPCustomCloudBase)
OnRequestComplete Fires when an individual HTTP request completes, providing the response result. (inherited from TTMSMCPCustomCloudBase)
OnRequestLog Fires for each log entry written when Logging is enabled. (inherited from TTMSMCPCustomCloudBase)
OnRequestProgress Fires periodically while an HTTP request is in progress to report download or upload progress. (inherited from TTMSMCPCustomCloudBase)
OnRequestStarted Fires when an HTTP request is dispatched and execution begins. (inherited from TTMSMCPCustomCloudBase)
OnRequestsComplete Fires when all queued HTTP requests in a batch have completed. (inherited from TTMSMCPCustomCloudBase)
Used by