OfficeDocumentReadResultSchema
OfficeIMO.Reader
Stable schema discovery and compatibility helpers for document read result transport payloads.
Inheritance
- object
- OfficeDocumentReadResultSchema
Methods
public static void EnsureSupported(string? schemaId, int schemaVersion) #Throws when a schema header cannot be consumed by this package.
Parameters
- schemaId string?
- schemaVersion int
public static string GetJsonSchema() #Loads the JSON Schema artifact embedded in the assembly and included in the NuGet package.
Returns
stringpublic static string GetJsonSchema(int schemaVersion) #Loads one supported versioned JSON Schema artifact embedded in the assembly and included in the NuGet package.
Parameters
- schemaVersion int
Returns
stringpublic static bool IsSupported(string? schemaId, int schemaVersion) #Returns true when a schema header can be consumed by this package.
Parameters
- schemaId string?
- schemaVersion int
Returns
boolInherited Methods
Fields
public const string Id #Stable schema identifier for shared document readback results.
officeimo.document.read-resultpublic const int MinimumSupportedVersion #First schema version covered by the stable compatibility contract. Versions 1 through 4 were experimental and are not accepted by the transport reader.
5public const int CurrentVersion #Current schema version emitted and accepted by this package.
14public const string JsonSchemaId #Stable JSON Schema identifier for current version 14 payloads.
urn:officeimo:schema:document-read-result:14public const string JsonSchemaFileName #File name used for the packaged current JSON Schema artifact.
officeimo.document.read-result.v14.schema.json