TTMSFNCCloudFileConversionJob Class
Represents a single conversion job. It tracks the job's identity, status and target output format, exposes its output files, and provides helpers to retrieve details, cancel the job and download its results.
API unit family: TMSFNCCloudFileConversion
Inherits from: TCollectionItem
Syntax
TTMSFNCCloudFileConversionJob = class(TCollectionItem)
Properties
| Name | Description |
|---|---|
| DataBoolean | User-defined Boolean associated with this job. |
| DataInteger | User-defined integer associated with this job. |
| DataObject | User-defined object associated with this job. |
| DataPointer | User-defined pointer associated with this job. |
| DataString | User-defined string associated with this job. |
| Id | Read-only provider identifier of the job. |
| Name | Read-only name of the job. |
| OutputFiles | Read-only collection of output files produced by the job. |
| OutputFormat | Read-only target format the job converts its source file to. |
| Status | Read-only status of the job in its conversion lifecycle. |
Methods
| Name | Description |
|---|---|
| CancelConversion | Cancels this conversion job on the service. |
| DownloadAllFilesToFiles | Downloads every output file of this job and saves them to a directory on disk. |
| DownloadAllFilesToStreams | Downloads every output file of this job into in-memory streams. |
| DownloadFileToFile | Downloads a single output file of this job to disk, selecting it by index. |
| DownloadFileToStream | Downloads a single output file of this job into an in-memory stream, selecting it by index. |
| GetDetails | Requests the current details of this job from the service, refreshing its status and output files. |
| GetOutputFileByID | Returns the output file with the given provider identifier. |