Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeConversionJobSerializer

Namespace OfficeIMO.Workflows
Assembly OfficeIMO.Workflows
Source revision 9ba015295d53 with working tree changes
Modifiers static

Strict, bounded JSON and safe local-file persistence for portable conversion jobs.

Inheritance

  • Object
  • OfficeConversionJobSerializer

Methods

public static OfficeConversionJob Deserialize(String json) #
Returns: OfficeConversionJob

Reads one schema version and rejects unknown fields, duplicate properties, numeric enums and oversized input.

Parameters

json System.String requiredposition: 0
ReadFile 2 overloads
public static OfficeConversionJob ReadFile(String path) #
Returns: OfficeConversionJob

Reads a bounded regular local file. The job must be outside its source, output and checkpoint trees.

Parameters

path System.String requiredposition: 0
public static OfficeConversionJob ReadFile(String path, out String sha256) #
Returns: OfficeConversionJob

Reads the job and SHA-256 of its exact bytes from the same bounded, link-checked file snapshot.

Parameters

path System.String requiredposition: 0
sha256 System.String requiredposition: 1
public static Void SaveFile(OfficeConversionJob job, String path, Boolean overwrite = false) #
Returns: Void

Saves atomically beside the destination. Explicit overwrite replaces only an unchanged valid job file; the parent must exist.

Parameters

job OfficeIMO.Workflows.OfficeConversionJob requiredposition: 0
path System.String requiredposition: 1
overwrite System.Boolean = false optionalposition: 2
public static String Serialize(OfficeConversionJob job) #
Returns: String

Serializes supported settings and secret references only.

Parameters

job OfficeIMO.Workflows.OfficeConversionJob requiredposition: 0
public static Void ValidateStoragePath(OfficeConversionJob job, String path) #
Returns: Void

Validates a job file's destination without writing. Hosts may use their own permission-aware publication after this check.

Parameters

job OfficeIMO.Workflows.OfficeConversionJob requiredposition: 0
path System.String requiredposition: 1

Fields

public const Int32 MaximumJobBytes #

Maximum UTF-8 job definition size, independent of document limits.

Value: 1048576