API Reference
OfficeConversionJob
A portable, local conversion batch. Paths resolve against the job file's directory, never the process directory.
Inheritance
- Object
- OfficeConversionJob
Usage
Explore 9 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 3
Accepted by parameters 6
Constructors
public OfficeConversionJob() #Methods
public OfficeConversionBatchRequest CreateRequest(String baseDirectory, OfficeConversionJobRuntimeOptions? runtime = null) #OfficeConversionBatchRequestCreates independent absolute-path execution settings. Secrets are resolved only when runtime options are supplied.
Parameters
- baseDirectory System.String
- runtime OfficeIMO.Workflows.OfficeConversionJobRuntimeOptions? = null
public static OfficeConversionJob FromRequest(OfficeConversionBatchRequest request, String baseDirectory) #OfficeConversionJobCaptures supported settings using paths relative to an absolute job directory. Runtime passwords and advanced settings are rejected.
Parameters
- request OfficeIMO.Workflows.OfficeConversionBatchRequest
- baseDirectory System.String
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String? InputDirectory { get; set; } #Source folder, relative to the job file or absolute.
public String[]? InputPaths { get; set; } #Explicit source files. A source folder, when supplied, defines their relative output layout.
public String OutputDirectory { get; set; } #Destination folder, relative to the job file or absolute.
public String TargetExtension { get; set; } #Destination extension. Defaults to PDF.
public String? ConversionRouteId { get; set; } #Optional exact route from the configured host's conversion catalog.
public Boolean Recursive { get; set; } #Whether to discover source subfolders.
public String[]? SourceExtensions { get; set; } #Optional source-extension filter.
public OfficeWorkflowOutputProfile OutputProfile { get; set; } #Cross-format output intent.
public OfficeWorkflowConflictPolicy ConflictPolicy { get; set; } #Existing destination behavior. Checkpoints require Fail.
public String? CheckpointDirectory { get; set; } #Optional separate durable state folder.
public Boolean RetryFailed { get; set; } #Whether recorded failed items may execute again.
public Int32 MaximumConcurrency { get; set; } #Concurrent conversions, from one through 32.
public Int32 MaximumFiles { get; set; } #Maximum discovered files, including skipped files.
public Int64 MaximumInputBytes { get; set; } #Maximum source bytes per file.
public Int64 MaximumOutputBytes { get; set; } #Maximum generated bytes per file.
public Int64 MaximumXmlCharactersInPart { get; set; } #Maximum XML characters per source part.
public OfficeConversionJobOptions Options { get; set; } #Portable renderer choices. Advanced native renderer objects remain runtime API settings.
public OfficeConversionJobSecrets Secrets { get; set; } #Runtime secret references. Values are never saved in a job.
Fields
public const String CurrentSchema #The supported saved-job schema.
officeimo.conversion.job.v1