TTMSFNCCloudFileConversion Class
Component that converts files through an online conversion service. It exposes the full conversion workflow at design time: select a back end, supply credentials, create jobs from a URL, a local file or base64 content, and download the converted output.
API unit family: TMSFNCCloudFileConversion
Inherits from: TTMSFNCCustomCloudFileConversion
Syntax
TTMSFNCCloudFileConversion = class(TTMSFNCCustomCloudFileConversion)
Remarks
This is the published descendant of TTMSFNCCustomCloudFileConversion and surfaces its properties and events to the Object Inspector.
Properties
| Name | Description |
|---|---|
| APIKey | API key used to authenticate with the selected conversion service. (inherited from TTMSFNCCustomCloudFileConversion) |
| CloudFileConversionInstance | Active conversion provider instance backing the component. (inherited from TTMSFNCCustomCloudFileConversion) |
| CloudFileConversionProperties | Credentials and provider settings passed to the active back end. (inherited from TTMSFNCCustomCloudFileConversion) |
| ConvertJobs | Collection of conversion jobs known to the component. (inherited from TTMSFNCCustomCloudFileConversion) |
| RetrieveDetailsInterval | Interval, in milliseconds, at which job details are polled while a job is running. (inherited from TTMSFNCCustomCloudFileConversion) |
| Service | Conversion back end the component uses to run jobs. (inherited from TTMSFNCCustomCloudFileConversion) |
Methods
| Name | Description |
|---|---|
| CancelConvertJob | Cancels a conversion job on the service, identified by its provider id. (inherited from TTMSFNCCustomCloudFileConversion) |
| ConvertFile | Creates a conversion job for a local file and uploads it to the service. (inherited from TTMSFNCCustomCloudFileConversion) |
| ConvertFileFromBase64 | Creates a conversion job from base64-encoded file content. (inherited from TTMSFNCCustomCloudFileConversion) |
| ConvertFileFromURL | Creates a conversion job that converts a file referenced by a URL to the requested output format. (inherited from TTMSFNCCustomCloudFileConversion) |
| DownloadFileToFile | Downloads the given output file and saves it to disk. (inherited from TTMSFNCCustomCloudFileConversion) |
| DownloadFileToStream | Downloads an output file into an in-memory stream, selecting the job and file by their provider ids. (inherited from TTMSFNCCustomCloudFileConversion) |
| ExtractFileConversionFileName | Extracts the file name, including its extension, from a local path or a URL. (inherited from TTMSFNCCustomCloudFileConversion) |
| GetConversionFileFormatFromString | Maps a file-extension string to its matching format value. (inherited from TTMSFNCCustomCloudFileConversion) |
| GetConvertJobById | Returns the job with the given provider identifier from the component's job collection. (inherited from TTMSFNCCustomCloudFileConversion) |
| GetConvertJobDetails | Requests the current details of a job, identified by its provider id, refreshing its status and output files. (inherited from TTMSFNCCustomCloudFileConversion) |
| GetConvertJobs | Retrieves the list of conversion jobs from the service and stores them in the component. (inherited from TTMSFNCCustomCloudFileConversion) |
| GetFileFormatText | Returns the file-extension text that corresponds to a format value. (inherited from TTMSFNCCustomCloudFileConversion) |
| GetStatusText | Returns a human-readable label for a job status value. (inherited from TTMSFNCCustomCloudFileConversion) |
| ValidFileName | Checks whether a file name is acceptable as a conversion source. (inherited from TTMSFNCCustomCloudFileConversion) |
Events
| Name | Description |
|---|---|
| OnConvertJobCancelled | Occurs when a conversion job has been cancelled. (inherited from TTMSFNCCustomCloudFileConversion) |
| OnConvertJobCreated | Occurs when a conversion job has been created on the service. (inherited from TTMSFNCCustomCloudFileConversion) |
| OnConvertJobFinished | Occurs when a job reaches a final state (successful, error or cancelled). (inherited from TTMSFNCCustomCloudFileConversion) |
| OnError | Occurs when a conversion operation reports an error. (inherited from TTMSFNCCustomCloudFileConversion) |
| OnFileDownloadedToFile | Occurs when an output file has been saved to disk. (inherited from TTMSFNCCustomCloudFileConversion) |
| OnFileDownloadedToStream | Occurs when an output file has been downloaded to a stream. (inherited from TTMSFNCCustomCloudFileConversion) |
| OnFileUploaded | Occurs when the source file for a job has been uploaded. (inherited from TTMSFNCCustomCloudFileConversion) |
| OnGetConvertJobDetails | Occurs when the details of a conversion job have been retrieved. (inherited from TTMSFNCCustomCloudFileConversion) |
| OnGetConvertJobs | Occurs when the list of conversion jobs has been retrieved. (inherited from TTMSFNCCustomCloudFileConversion) |